--- title: "Properties" manual: "TypoScript Explained" version: "main" permalink: "https://docs.typo3.org/permalink/t3tsref:gifbuilder-properties@main" source: "Gifbuilder/Properties.rst" rendered: "2026-09-28T04:44:10+00:00" --- # Properties {#gifbuilder-properties} - [1,2,3,4...](https://docs.typo3.org/permalink/t3tsref:1-2-3-4@main) - [backColor](https://docs.typo3.org/permalink/t3tsref:backcolor@main) - [charRangeMap](https://docs.typo3.org/permalink/t3tsref:charrangemap@main) - [format](https://docs.typo3.org/permalink/t3tsref:format@main) - [maxHeight](https://docs.typo3.org/permalink/t3tsref:maxheight@main) - [maxWidth](https://docs.typo3.org/permalink/t3tsref:maxwidth@main) - [offset](https://docs.typo3.org/permalink/t3tsref:offset@main) - [quality](https://docs.typo3.org/permalink/t3tsref:quality@main) - [speed](https://docs.typo3.org/permalink/t3tsref:speed@main) - [transparentBackground](https://docs.typo3.org/permalink/t3tsref:transparentbackground@main) - [transparentColor](https://docs.typo3.org/permalink/t3tsref:transparentcolor@main) - [workArea](https://docs.typo3.org/permalink/t3tsref:workarea@main) - [XY](https://docs.typo3.org/permalink/t3tsref:xy@main) ## 1,2,3,4... {#gifbuilder-properties-array} - **1,2,3,4...** - *Type:* [Gifbuilder Object](https://docs.typo3.org/permalink/t3tsref:gifbuilder-object-names@main) \+ .if ([->if](https://docs.typo3.org/permalink/t3tsref:if@main)) `.if` is a property of all GIFBUILDER objects. If the property is present and **not** set, the object is **not** rendered! This corresponds to the functionality of `.if` of the [stdWrap](https://docs.typo3.org/permalink/t3tsref:stdwrap@main) function. ## backColor {#gifbuilder-properties-backcolor} - **backColor** - *Type:* [Colors in TypoScript GIFBUILDER](https://docs.typo3.org/permalink/t3tsref:data-type-graphiccolor@main) / [stdWrap](https://docs.typo3.org/permalink/t3tsref:stdwrap@main) - *Default:* white Background color of the image. ## charRangeMap {#gifbuilder-properties-charrangemap} ### \[array\] {#gifbuilder-properties-charrangemap-array} - **charRangeMap.\[array\]** - *Type:* string Basename of font file to match for this configuration. Notice that only the *filename* of the font file is used - the path is stripped off. This is done to make matching easier and avoid problems when font files might move to other locations in extensions etc. So if you use the font file `EXT:my_extension/Resources/Private/Fonts/vera.ttf` or `EXT:install/Resources/Private/Font/vera.ttf` both of them will match with this configuration. **The key:** The value of the array key will be the key used when forcing the configuration into [splitRendering](https://docs.typo3.org/permalink/t3tsref:gifbuilder-text-splitrendering@main) configuration of the individual [GIFBUILDER objects](https://docs.typo3.org/permalink/t3tsref:gifbuilder-object-names@main). In the [\[array\]](https://docs.typo3.org/permalink/t3tsref:gifbuilder-properties-charrangemap-array@main) example below the key is `123`. > [!NOTE] > If the key is already found in the local GIFBUILDER configuration the > content of that key is respected and not overridden. Thus you can make > local configurations which override the global setting. ### \[array\].charMapConfig {#gifbuilder-properties-charrangemap-charmapconfig} - **charRangeMap.\[array\].charMapConfig** - *Type:* [TEXT](https://docs.typo3.org/permalink/t3tsref:gifbuilder-text@main) / [splitRendering.\[array\]](https://docs.typo3.org/permalink/t3tsref:gifbuilder-text-splitrendering@main) configuration splitRendering configuration to set. See [GIFBUILDER TEXT object](https://docs.typo3.org/permalink/t3tsref:gifbuilder-text@main) for details. ### \[array\].fontSizeMultiplicator {#gifbuilder-properties-charrangemap-fontsizemultiplicator} - **charRangeMap.\[array\].fontSizeMultiplicator** - *Type:* double If set, this will take the font size of the [GIFBUILDER TEXT object](https://docs.typo3.org/permalink/t3tsref:gifbuilder-text@main) and multiply with this amount (xx.xx) and override the [fontSize](https://docs.typo3.org/permalink/t3tsref:gifbuilder-text-fontsize@main) property inside [\[array\].charMapConfig](https://docs.typo3.org/permalink/t3tsref:gifbuilder-properties-charrangemap-charmapconfig@main). ### \[array\].pixelSpaceFontSizeRef {#gifbuilder-properties-charrangemap-pixelspacefontsizeref} - **charRangeMap.\[array\].pixelSpaceFontSizeRef** - *Type:* double If set, this will multiply the four \[x/y\]Space\[Before/After\] properties of split rendering with the relationship between the font size and this value. In other words: Since pixel space may vary depending on the font size used, you can specify by this value at what font size the pixel space settings are optimized and for other font sizes this will automatically be adjusted according to this font size. **Example**: **EXT:site_package/Configuration/Sets/Main/setup.typoscript** ```typoscript _GIFBUILDER.charRangeMap { 123 = arial.ttf 123 { charMapConfig { fontFile = EXT:install/Resources/Private/Font/vera.ttf value = 48-57 color = green xSpaceBefore = 3 xSpaceAfter = 3 } pixelSpaceFontSizeRef = 24 } } ``` In this example `xSpaceBefore` and `xSpaceAfter` will be "3" when the font size is 24. If this configuration is used on a [GIFBUILDER TEXT object](https://docs.typo3.org/permalink/t3tsref:gifbuilder-text@main) where the font size is only 16, the spacing values will be corrected by "16/24", effectively reducing the pixel space to "2" in that case. ## format {#gifbuilder-properties-format} - **format** - *Type:* "gif" / "jpg" / "jpeg" / "png" / "webp" / "avif" - *Default:* png File type of the output image. The quality can be defined globally: - [$TYPO3_CONF_VARS\['GFX'\]\['jpg_quality'\]](https://docs.typo3.org/m/typo3/reference-coreapi/main/en-us/Configuration/Typo3ConfVars/GFX.html#typo3ConfVars_gfx_jpg_quality) for a JPG image - [$TYPO3_CONF_VARS\['GFX'\]\['webp_quality'\]](https://docs.typo3.org/m/typo3/reference-coreapi/main/en-us/Configuration/Typo3ConfVars/GFX.html#typo3ConfVars_gfx_webp_quality) for a WebP image - [$TYPO3_CONF_VARS\['GFX'\]\['avif_quality'\]](https://docs.typo3.org/m/typo3/reference-coreapi/main/en-us/Configuration/Typo3ConfVars/GFX.html#typo3ConfVars_gfx_webp_quality) for a AVIF image or via the [quality](https://docs.typo3.org/permalink/t3tsref:gifbuilder-properties-quality@main) property on a per-image basis. ## maxHeight {#gifbuilder-properties-maxheight} - **maxHeight** - *Type:* positive integer / [stdWrap](https://docs.typo3.org/permalink/t3tsref:stdwrap@main) Maximal height of the image file. ## maxWidth {#gifbuilder-properties-maxwidth} - **maxWidth** - *Type:* positive integer / [stdWrap](https://docs.typo3.org/permalink/t3tsref:stdwrap@main) Maximal width of the image file. ## offset {#gifbuilder-properties-offset} - **offset** - *Type:* x,y [+calc](https://docs.typo3.org/permalink/t3tsref:gifbuilder-calc@main) / [stdWrap](https://docs.typo3.org/permalink/t3tsref:stdwrap@main) - *Default:* 0,0 Offset all objects on the image. ## quality {#gifbuilder-properties-quality} - **quality** - *Type:* Between 10 (lowest quality) and 100 (highest quality) / additionally, 101 (lossless) for WebP Sets the quality of the image: - JPG, if [format](https://docs.typo3.org/permalink/t3tsref:gifbuilder-properties-format@main) = jpg/jpeg. - WebP, if [format](https://docs.typo3.org/permalink/t3tsref:gifbuilder-properties-format@main) = webp. Setting the quality to "101" equivalents to ["lossless" compression](https://developers.google.com/speed/webp/docs/compression#lossless_webp). ## speed {#gifbuilder-properties-speed} - **speed** - *Type:* integer Set the "speed" for files in format AVIF (See [https://www.php.net/manual/en/function.imageavif.php](https://www.php.net/manual/en/function.imageavif.php) for more details). ## transparentBackground {#gifbuilder-properties-transparentbackground} - **transparentBackground** - *Type:* boolean / [stdWrap](https://docs.typo3.org/permalink/t3tsref:stdwrap@main) Set this flag to render the background transparent. TYPO3 makes the color found at position 0,0 of the image (upper left corner) transparent. If you render text, you should leave the [niceText](https://docs.typo3.org/permalink/t3tsref:gifbuilder-text-nicetext@main) option **off** as the result will probably be more precise without the `niceText` antialiasing hack. ## transparentColor {#gifbuilder-properties-transparentcolor} - **transparentColor** - *Type:* [Colors in TypoScript GIFBUILDER](https://docs.typo3.org/permalink/t3tsref:data-type-graphiccolor@main) / [stdWrap](https://docs.typo3.org/permalink/t3tsref:stdwrap@main) Specify a color that should be transparent. ### closest {#gifbuilder-properties-transparentcolor-closest} - **transparentColor.closest** - *Type:* boolean This will allow for the closest color to be matched instead. You may need this, if your image is not guaranteed "clean". > [!NOTE] > You may experience that this does not work, if you render text with the > [niceText](https://docs.typo3.org/permalink/t3tsref:gifbuilder-text-nicetext@main) option. ## workArea {#gifbuilder-properties-workarea} - **workArea** - *Type:* x,y,w,h [+calc](https://docs.typo3.org/permalink/t3tsref:gifbuilder-calc@main) / [stdWrap](https://docs.typo3.org/permalink/t3tsref:stdwrap@main) Define the work area on the image file. All the [GIFBUILDER objects](https://docs.typo3.org/permalink/t3tsref:gifbuilder-object-names@main) will see this as the dimensions of the image file regarding alignment, overlaying of images and so on. Only [TEXT objects](https://docs.typo3.org/permalink/t3tsref:gifbuilder-text@main) exceeding the boundaries of the work area will be printed outside this area. ## XY {#gifbuilder-properties-xy} - **XY** - *Type:* x,y [+calc](https://docs.typo3.org/permalink/t3tsref:gifbuilder-calc@main) (1-2000) / [stdWrap](https://docs.typo3.org/permalink/t3tsref:stdwrap@main) - *Default:* 120,50 Size of the image file.