Mask (knock-out) the background for selected images. This data type lets you overlay them in other layers with a transparency outside of the subject image.

This data type is optional and off by default.

KnockoutBackgroundOptions=[corner, tolerance, fill]



If you are configuring KnockoutBackgroundOptions in Adobe Experience Manager, use the following parameters instead:

  • kbCorner
  • kbTolerance
  • kbFillMethod

For example: kbCorner=UpperLeft&kbTolerance=0.2&kbFillMethod=MatchPixel

Name Type Description
corner xsd:string Selects the corner that you want to work with. corner accepts these values:
  • UpperLeft
  • BottomLeft
  • UpperRight
  • BottomRight
tolerance xsd:double An optional setting that removes white space from image edges based on transparency. Accepts a range of values from 0.0 to 1.0. Specify:
  • 0 to match colors exactly.
  • 1 to enable the most color differences.
fillMethod xsd:string

Control pixel transparency in the location specified by the corner variable. The fillMethod accepts these values:

  • FloodFill: Turns all pixels in the specified corner transparent.
  • MatchPixel: Turns all matching pixels transparent regardless of location.


<complexType name="KnockoutBackgroundOptions">
            <!-- corner one of UpperLeft, BottomLeft, UpperRight, BottomRight -->
            <element name="corner" type="xsd:string" minOccurs="1"/>
            <!-- Tolerance real value between 0.0 and 1.0 -->
            <element name="tolerance" type="xsd:double" minOccurs="0"/>
            <!-- one of FloodFill or MatchPixel is required -->
            <element name="fillMethod" type="xsd:string" minOccurs="1"/>

Used By

The KnockoutBackgroundOptions type is used by:

On this page