XBorderFilter V0.96 for JAlbum Documentation - Borders

Other chapters:

Borders

Borders are bands on top of the image under consideration. They may be of any color, transparency, with or without rounded corners and an arbitrary margin to the edges of the image. There is a variety of parameters to control borders.

Border Widths

The width of the border to draw can be controlled by 5 parameters:

Unique Border Widths

This parameter denotes border widths that are uniform in all 4 quarters. The value can be overwritten by the edgewise flavour of this parameter.

key	description	available values	examples	default value
boWidth	width of the border bands to be created, in pixels; the first value indicates the width of the band nearest to the image edge	(list of) positive integers	boWidth=10 boWidth="15" boWidth="10,20"	0 (no border)

Edge-wise Border Widths

This parameter denotes border widths that are valid for only one of the 4 quarters. The value overwrites boWidth (if given) for the denoted direction, all other directions are left untouched.

key	description	available values	examples	default value
boWidthN boWidthE boWidthS boWidthW	width of the border bands to be created, in pixels; the first value indicates the width of the band nearest to the image edge	(list of) positive integers	boWidthE=10 boWidthN="15" boWidthS="10,20,30,40"	0 (no border)

If more than one parameter boWidth* is given and the entered lists contain a different number of entries, the number of valid list entries is calculated as the smallest number of list entries observed in any of the parameters.

Example Images

class=XBorderFilter boWidth=20

class=XBorderFilter boWidth=20 boWidthN=5 boWidthS=40

Border Colors

The color of the border bands to draw can be controlled by the parameter boCol

key	description	available values	examples	default value
boCol	colors of the border (bands) to be created	(list of) color names or #......-values	boCol=black boCol="white" boCol="black,white,black" boCol=#ff0000	white

If the number of colors is less than the number of bands, as given by boWidth*, the last given value of boCol is repeated as often as necessary.

Example Images

class=XBorderFilter boWidth=10,10,10 boCol=red,green,blue

Border Transparencies

The transparency of the border bands to draw can be controlled by the parameter boTrans

key	description	available values	examples	default value
boTrans	transparencies of the border (bands) to be created, in %	(list of) positive integers	boTrans=20 boTrans="25" boTrans="100,100,0"	50%

If the number of transparencies is less than the number of bands, as given by boWidth*, the last given value of boTrans is repeated as often as necessary.

Example Images

class=XBorderFilter boWidth=10,10,10 boTrans=20,50,80

Border Blending

The colors and transparencies of the border bands can be blended. It is controlled by the parameter boBlend

key	description	available values	examples	default value
boBlend	flag, indicating the border colors and transparencies are to be blended that means, that the colors and transparencies are blended between subsequent bands, using linear recombination	true, false	boBlend (sets boBlend to true) boBlend=false	false

If this flag is used, boCol and boTrans must contain one element more than boWidth* Otherwise, the last value of this lists are repeated.

Example Images

class=XBorderFilter boWidth=10,10 boCol=red,green,blue boTrans=30,50,70 boBlend

Border Margin

The margin between the outer edges of the border and the edges of the underlying image can be controlled by the parameter boMargin

key	description	available values	examples	default value
boMargin	margin between image edge and outer border edge, in pixels	positive integer	boMargin=20	0 (no margin)

Example Images

class=XBorderFilter boWidth=20 boMargin=10

Border Clip

Border corners can be rounded. This is controlled by the paramter boClip

key	description	available values	examples	default value
boClip	clip radius, that ist the radius of the rounding on the border corners	positive integer	boClip=20	0 (no clipping)

Example Images

class=XBorderFilter boWidth=20 boClip=20

Top