imageSetBackgroundColor

Sets the background color for the ColdFusion image. The background color is used for clearing a region. Setting the background color only affects the subsequent imageClearRect calls

imageSetBackgroundColor(name, color) → returns void

Member Function Syntax

someImage.setBackgroundColor(color)

  1. CFDocs
  2. Functions
  3. ColdFusion 8 New Functions and Tags
  4. imageSetBackgroundColor
  5. CF8+
  6. Lucee4.5+
  7. 0 Issue
  8. Edit
See Also:   ImageClearRect   ImageSetAntialiasing   IsImageFile

Argument Reference

name string
Required

The ColdFusion image on which this operation is performed.

color string
Required
Default: black

Background color
Values:
  • Hexadecimal value of RGB color. For example, specify the color white as ##FFFFFF or FFFFFF.
  • String value of color (for example, 'black'', 'red'', 'green').
  • List of three numbers for (R,G,B) values. Each value must be in the range 0–255.

Examples
Sample code invoking the imageSetBackgroundColor function

This example shows how to set the background color, and then draw a rectangle on an image filled with that color. 

<!--- Create a ColdFusion image from an existing JPEG file. ---> 
 <cfimage name="myImage" source="../cfdocs/images/artgallery/maxwell01.jpg"> 
 <!--- Turn on antialiasing to improve image quality. ---> 
 <cfset imageSetAntialiasing(myImage)> 
 <!--- Set the background color to magenta. ---> 
 <cfset imageSetBackgroundColor(myImage,"magenta")> 
 <!--- Clear the rectangle specified on myImage with the background color specified for the image. ---> 
 <cfset imageClearRect(myImage,36,45,100,100)> 
 <!--- Display the modified image in a browser. ---> 
 <cfimage source="#myImage#" action="writeToBrowser">

CF 11+ Clears the specified rectangle (50x50) from the center of the image (x=50, y-50) using a new background color (#116185)

imgObj = imageRead("http://cfdocs.org/apple-touch-icon.png");
imgObj.setBackgroundColor('116185');
imgObj.clearRect(50,50,50,50);
cfimage(action="writeToBrowser", source=imgObj);

Signup for cfbreak to stay updated on the latest news from the ColdFusion / CFML community. One email, every friday.

Fork me on GitHub