ibexa

Caution: This documentation is for eZ Publish legacy, from version 3.x to 5.x.

Filters

Summary

Lists the filters for the "rss" alias.

Usage

 

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

Description

A list of filters to run, each filter must be supported by the active image converters. 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.

A list of filters:

  • 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

According to the RSS 1.0 / RSS 2.0 the following specification should be taken into account:

  • maximum value for width is 144, default value is 88,
  • maximum value for height is 400, default value is 31.

This setting is case sensitive.

Examples

Filters[]=geometry/scale=88;31

Ester Heylen (10/05/2010 1:56 pm)

Ester Heylen (11/05/2010 11:23 am)


Comments

There are no comments.