Caution: This documentation is for eZ Publish legacy, from version 3.x to 6.x.
For 5.x documentation covering Platform see eZ Documentation Center, for difference between legacy and Platform see 5.x Architecture overview.

Filters

Summary

Lists the filters to be used by the GD image converter.

Usage

 

Filters[]=<filter>=<filter-parameter>

Description

A list of filters to run, each filter must be supported by the active image converter, in this case GD.
The parameter to use is the pixel size of the image. So when you need to use the width, use the horizontal pixel size of the image, and when you need to use the height use the vertical pixel size of the image.
The following filters are supported by GD:

  • geometry/scale: scales the image to the size specified, but maintaining the aspect ratio.
    The parameters here will be:
    Filter[]=geometry/scale=<width>;<height>
    
  • geometry/scalewidth: scales the image to the widthsize specified, but maintaining the aspect ratio.
    The parameters here will be:
    Filter[]=geometry/scalewidth=<width>
    
  • geometry/scaleheight: scales the image to the heightsize specified, but maintaining the aspect ratio.
    The parameters here will be:
    Filter[]=geometry/scaleheight=<height>
    
  • geometry/scaledownonly: scales the image to the size specified, but maintaining the aspect ratio. The image will not be scaled if the source size is smaller than the destination size.
    The parameters here will be:
    Filter[]=geometry/scaledownonly=<width>;<height>
    
  • geometry/scalewidthdownonly: scales the image to the widthsize specified, but maintaining the aspect ratio. The image will not be scaled if the source size is smaller than the destination size.
    The parameters here will be:
    Filter[]=geometry/scalewidthdownonly=<width>
    
  • geometry/scaleheightdownonly: scales the image to the heightsize specified, but maintaining the aspect ratio. The image will not be scaled if the source size is smaller than the destination size.
    The parameters here will be:
    Filter[]=geometry/scaleheightdownonly=<height>
    
  • geometry/scaleexact: scales the image to the exact size specified, but without maintaining the aspect ratio.
    The parameters here will be:
    Filter[]=geometry/scaleexact=<width>;<height>
    
  • geometry/scalepercent: scales the image to the size specified, but without maintaining the aspect ratio.
    The parameters here will be:
    Filter[]=geometry/scalepercent=<%>
    
  • geometry/crop: crops the image to the crop size specified and according to the crop location specified. The parameters here will be:
    Filter[]=geometry/crop=<width after cropping>;<height after  cropping>;<width location of the cropped image in respect to the  original image>;<height location of the cropped image in respect  to the original image>
    
  • colorspace/gray
  • luminance/gray: changes the colors of the image based on the luminance.
  • luminance/sepia: changes the colors of the image based on the luminance
  • color/monochrome: changes the colors of the image based on the threshold value. The luminance is calculated and if it is in the specified threshold range it will use the specified color for that range.
  • border/color
  • border/width

This setting is case sensitive.

Examples

Filters[]=geometry/scale=300;300

Ester Heylen (10/05/2010 3:06 pm)

Ester Heylen (10/05/2010 3:06 pm)


Comments

There are no comments.