API: Img

Filename:
fwpImg_imageFile.ctyp

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

fwp_imageFile (Type)

Description

Uses ImageMagick and PassThru to retrieve properties of and execute image manipulation commands upon a specified image file. Additionally, some standard file commands are available as member tags for manipulating the disk file.

Three global vars need to be defined in _initMasters.lgc: $fw_gPassthruUser and $fw_gPassthruPswd for the -username assigned to a user allowed to use PassThru, and $fw_gServerRoot is the fully qualified root path to the virtual host folder which is then prefixed to the path and file name provided to ImageMagick commands.

Syntax

var:'myImg'=(fwp_imageFile: fileName);

$myImg->instance variable;

$myImg->member tag;

Parameters & Member Tags

fileName (unnamed) - required : the virtual host root relative path and file name of the image.

Instance Variables: Image Properties

->'property' = retrieves any one of the following ImageMagick properties. Additionally, the Geometry property has been split into Width and Height.

• Image, Format, Geometry, Class, Type, Depth, Colors, Profile-APP12,
  Resolution, Filesize, Interlace, BackgroundColor, BorderColor, MatteColor,
  UndefinedIterations, Compression, Signature, Tainted, Time, ElapsedTime
  Width, Height

Member Tags: Image Manipulation

Each of the following member tags also has a standard custom tag counterpart (in fact, the ctype simply passes paramaters to the ctags). To view the requirements for these parameters, refer to the links to the custom tag entries.

Underlined parameters below are required, the rest are optional.

->annotate: 
   -destfile=filePath, 
   -string=string, 
   -font=fontname, 
   -fill=color, 
   -pointsize=integer, 
   -location=integer(x),integer(y);

->compressJPEG: 
   -destfile=filePath, 
   -quality=integer(0-100);

->convert: 
   -destfile=filePath, 
   -type=filetype;

->despeckle: 
   -destfile=filePath;

->frame: 
   -destfile=filePath, 
   -width=integer, 
   -height=integer, 
   -bevelin=integer, 
   -bevelout=integer, 
   -mattecolor=color;

->grayscale: 
   -destfile=filePath;

->raise: 
   -destfile=filePath, 
   -width=integer, 
   -height=integer;

->resize: 
   -destfile=filePath, 
   -width=integer;

->rotate: 
   -destfile=filePath, 
   -angle=integer, 
   -bgcolor=color;

->sharpen: 
   -destfile=filePath, 
   -radius=decimal, 
   -sigma=decimal;

->unsharp: 
   -destfile=filePath, 
   -radius=decimal, 
   -sigma=decimal, 
   -amount=decimal, 
   -threshold=decimal;

Member Tags: Disk File Manipulation

->copy: -destfile=filePath;

->delete;

->move: -destfile=filePath;

->rename: -destfile=filePath;