Properties¶

1,2,3,4...¶

1,2,3,4... ¶

Type: Gifbuilder Object + .if (->if)

.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 function.

backColor¶

backColor ¶

Type: GraphicColor / stdWrap
Default: white

Background color of the image.

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 configuration of the individual GIFBUILDER objects. In the [array] 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¶

charRangeMap.[array].charMapConfig ¶

Type: TEXT / splitRendering.[array] configuration

splitRendering configuration to set. See GIFBUILDER TEXT object for details.

[array].fontSizeMultiplicator¶

charRangeMap.[array].fontSizeMultiplicator ¶

Type: double

If set, this will take the font size of the GIFBUILDER TEXT object and multiply with this amount (xx.xx) and override the fontSize property inside [array].charMapConfig.

[array].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:

_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 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¶

Changed in version 13.0

The default format is now "png". Before TYPO3 v13.0 this was "gif".

New in version 13.0

Support for WebP has been added.

format ¶

Type: "gif" / "jpg" / "jpeg" / "png" / "webp"
Default: png

File type of the output image.

The quality can be defined globally:

$TYPO3_CONF_VARS['GFX']['jpg_quality'] for a JPG image
$TYPO3_CONF_VARS['GFX']['webp_quality'] for a WebP image

or via the quality property on a per-image basis.

maxHeight¶

maxHeight ¶

Type: positive integer / stdWrap

Maximal height of the image file.

maxWidth¶

maxWidth ¶

Type: positive integer / stdWrap

Maximal width of the image file.

offset¶

offset ¶

Type: x,y +calc / stdWrap
Default: 0,0

Offset all objects on the image.

quality¶

New in version 13.0

The quality can be set for WebP images.

quality ¶

Type: Between 10 (lowest quality) and 100 (highest quality) / additionally, 101 (lossless) for WebP

Sets the quality of the image:

JPG, if format = jpg/jpeg.
WebP, if format = webp. Setting the quality to "101" equivalents to "lossless" compression.

transparentBackground¶

transparentBackground ¶

Type: boolean / stdWrap

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 option off as the result will probably be more precise without the niceText antialiasing hack.

transparentColor¶

transparentColor ¶

Type: GraphicColor / stdWrap

Specify a color that should be transparent.

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 option.

workArea¶

workArea ¶

Type: x,y,w,h +calc / stdWrap

Define the work area on the image file. All the GIFBUILDER objects will see this as the dimensions of the image file regarding alignment, overlaying of images and so on. Only TEXT objects exceeding the boundaries of the work area will be printed outside this area.

XY¶

XY ¶

Type: x,y +calc (1-2000) / stdWrap
Default: 120,50

Size of the image file.

reduceColors¶

reduceColors ¶: Changed in version 13.0

This property has been removed.