Lucee Function Reference

imageaddborder()

Adds a rectangular border around the outside edge of a image.

Example

imageaddborder(any image,[number thickness,[string color,[string borderType]]]):void

Category

image

Arguments

The arguments for this function are set. You can not use other arguments except the following ones.
Name Type Required Default Value Description
image any  Yes   The image on which this operation is performed.  
thickness number  No 1 Thickness of the border in pixels. The default value is 1. The border is added to the outside edge of the image; the image area is increased accordingly.  
color string  No black Optional. Border color. The default border color is black. See Usage.
Only valid if the borderType is not specified or if borderType = "constant".  
borderType string  No constant The type of border:
  • zero: Sets the border color to black.
  • constant: Sets the border to the specified color (default).
  • copy: Sets sample values to copies of the nearest valid pixel. For example, pixels to the left of the valid rectangle assume the value of the valid edge pixel in the same row. Pixels both above and to the left of the valid rectangle assume the value of the upper-left pixel.
  • reflect: Mirrors the edges of the source image. For example, if the left edge of the valid rectangle is located at x = 10, pixel (9, y) is a copy of pixel (10, y) and pixel (6, y) is a copy of pixel (13, y).
  • wrap: Tiles the source image in the plane.