API: Img

Filename:
fwpImg_annotate.ctag

Released With:
5.0.0

Current Version:
1.1.1

Status: Active

Min Lasso Tested: 8.1.0

Max Lasso Tested: 8.5.3

Related:

API Reference

fwpImg_annotate (Tag)

Description

Uses ImageMagick and PassThru to overlay text onto a specified image file.

Use this custom tag format, or the fwp_imageFile custom type format.

Syntax

fwpImg_annotate:
   -srcfile = path,
   -destfile = path,
   -string = string,
   -font=string,
   -fill = string|#000000,
   -pointsize=integer,
   -location=x,y;

Parameters & Member Tags

-srcFile - required : a qualified pathname to the image file to be modified

-destFile - required : a qualified pathname for the new image file

-string - required : the text string to be overlayed onto the image (no line wrapping occurs, and only one line is drawn)

-font - optional : the name of the font. The font name must be from a type.mgk configuration file (i.e. type-windows.mgk, type-ghostscript.mgk). The location of that file will vary depending on how ImageMagick was installed. Default is Helvetica-Bold.

-fill - optional : the fill color of the text. Use either english names as found in the colors.mgk file, or use #RRGGBB values. Default is white.

-pointsize - optional : the size of the text in points. Default is 24.

-location - optional : the x,y pixel coordinate of the lower left baseline of the text where 0,0 is the top left corner of the image. 10,50 would be down 10, and right 50 pixels. Default 10,10+pointsize.

Examples

fwpImg_annotate:
   -srcfile = 'ford-gt40.jpg',
   -destfile = 'ford-gt40-ANNOTATE.jpg',
   -string = 'My DreamCar!',
   -font='Helvetica-Bold,
   -fill = 'white',
   -pointsize = 24,
   -optional = '10,50';