uri.image

Uri: Image

Returns the relative or absolute URI for the image resource or it’s derivate if differing dimesions are provided.

Arguments

additionalAttributes

DataType
mixed
Required
false
Description
Additional tag attributes. They will be added directly to the resulting HTML tag.

data

DataType
mixed
Required
false
Description
Additional data-* attributes. They will each be added with a “data-” prefix.

aria

DataType
mixed
Required
false
Description
Additional aria-* attributes. They will each be added with a “aria-” prefix.

src

DataType
mixed
Required
false
Description
Path to the media resource(s). Can contain single or multiple paths for videos/audio (either CSV, array or implementing Traversable).

relative

DataType
boolean
Default
true
Required
false
Description
If FALSE media URIs are rendered absolute. URIs in backend mode are always absolute.

width

DataType
string
Required
false
Description
Width of the image. This can be a numeric value representing the fixed width of the image in pixels. But you can also perform simple calculations by adding “m” or “c” to the value. See imgResource.width for possible options.

height

DataType
string
Required
false
Description
Height of the image. This can be a numeric value representing the fixed height of the image in pixels. But you can also perform simple calculations by adding “m” or “c” to the value. See imgResource.width for possible options.

maxW

DataType
integer
Required
false
Description
Maximum Width of the image. (no upscaling)

maxH

DataType
integer
Required
false
Description
Maximum Height of the image. (no upscaling)

minW

DataType
integer
Required
false
Description
Minimum Width of the image.

minH

DataType
integer
Required
false
Description
Minimum Height of the image.

format

DataType
string
Required
false
Description
Format of the processed file - also determines the target file format. If blank, TYPO3/IM/GM default is taken into account.

quality

DataType
integer
Required
false
Description
Quality of the processed image. If blank/not present falls back to the default quality defined in install tool.

treatIdAsReference

DataType
boolean
Required
false
Description
When TRUE treat given src argument as sys_file_reference record. Applies only to TYPO3 6.x and above.

canvasWidth

DataType
integer
Required
false
Description
Width of an optional canvas to place the image on.

canvasHeight

DataType
integer
Required
false
Description
Height of an optional canvas to place the image on.

canvasColor

DataType
string
Required
false
Description
Background color of an optional canvas to place the image on (hex triplet).

transparencyColor

DataType
string
Required
false
Description
Color to set transparent when using canvas feature (hex triplet).

crop

DataType
string
Required
false
Description
Information generated by the backend’s graphical cropping UI