Lucee Function Reference

imagedrawtext()

Draws a text string on a image with the baseline of the first character positioned at (x,y) in the image.

Example

imagedrawtext(any image,string string,number x,number y,[struct attributeCollection]):void

Category

image

Arguments

The arguments for this function are set. You can not use other arguments except the following ones.
Name Type Required Description
image any  Yes The image on which this operation is performed.  
string string  Yes the text to draw.  
x number  Yes The x coordinate for the start point of the string.  
y number  Yes The y coordinate for the start point of the string.  
attributeCollection struct  No a structure used to specify the text characteristics. the following keys are supported:
  • font: The name of the font used to draw the text string. If you do not specify the font attribute, the text is drawn in the default system font.
  • size: The font size for the text string. The default value is 10 points.
  • style: The style to apply to the font ( bold,italic,boldItalic,plain (default) ).
  • strikethrough: a boolean that specify whether strikethrough is applied to the text image, default is false.
  • underline: a boolean that specify whether underline is applied to the text image, default is false.