Tags · Functions · Objects
Lucee Tag Reference
Choose a tag:

Tag <CFIMAGE>

Lets you resize and add labels to GIF and JPEG format images.

Body

This tag can't have a body.

Example

	<cfimage
		[action="string"]
		[angle="number"]
		[base64="boolean"]
		[color="string"]
		[destination="string"]
		[difficulty="string"]
		[fonts="string"]
		[fontsize="number"]
		[format="string"]
		[height="string"]
		[isbase64="boolean"]
		[name="string"]
		[overwrite="boolean"]
		[passthrough="string"]
		[quality="number"]
		[source="any"]
		[structname="string"]
		[text="string"]
		[thickness="number"]
		[width="string"]>
	
This tag is also supported within cfscript
	<cfscript>
		image
		[action="string"]
		[angle="number"]
		[base64="boolean"]
		[color="string"]
		[destination="string"]
		[difficulty="string"]
		[fonts="string"]
		[fontsize="number"]
		[format="string"]
		[height="string"]
		[isbase64="boolean"]
		[name="string"]
		[overwrite="boolean"]
		[passthrough="string"]
		[quality="number"]
		[source="any"]
		[structname="string"]
		[text="string"]
		[thickness="number"]
		[width="string"];
	</cfscript>

Attributes

The attributes for this tag are fixed. Except for the following attributes no other attributes are allowed.
Name Type Required Description
action string No Action to execute. 
angle number No Angle in degrees to rotate the image. 
base64 boolean No should action "writetobrowser" embed the source of the image as base64 encoded string, default is false. 
color string No Border color. Hexadecimal value or supported named color. For a hexadecimal value, use the form "#xxxxxx" or "xxxxxx", where x = 0-9 or A-F; use two number signs or none. 
destination string No 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 rotate actions require a name attribute or a destination attribute.
You can specify both.
If you do not enter a destination,
the CAPTCHA image is placed inline in the HTML output and displayed in the web browser. 
difficulty string No Level of complexity of the CAPTCHA text.
Specify one of the following levels of text distortion:
low, medium, high 
fonts string No One or more valid fonts to use for the CAPTCHA text. Separate multiple fonts with commas.
Lucee supports only the system fonts that the JDK can recognize. For example, TTF fonts in the Windows directory are supported on Windows. 
fontsize number No font size of the text in the CAPTCHA image. 
format string No Format of the image displayed in the browser.
If you do not specify a format, the image is displayed in PNG format. 
height string No Height in pixels of the image.
For the resize attribute, you also can specify the height as a percentage.
When you resize an image, if you specify a value for the width. 
isbase64 boolean No Specifies whether the source is a Base64 string 
name string No Name of the 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 boolean No If the destination file already exists, Lucee generates an error if the overwrite action is not set to yes. 
passthrough string No HTML attributes that are not explicitly supported by cfimage.
If you specify an attribute and value,
they are passed to the tag "img". 
quality number No 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 any No source file 
structname string No Name of the structure to be created. 
text string No 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 number No Border thickness in pixels. The border is added to the outside edge of the source image, increasing the image area accordingly. 
width string No Width in pixels of the image.