imgfn

FreeMarker development only

imgfn templating functions provide useful functions for handling image resources stored in any workspace. They are commonly used to resolve image variations.

imgfn templating functions are provided by the Imaging module.

Magnolia recommends you store images in the DAM workspace and use damfn templating functions instead to benefit from the DAM API (see How to work with images using damfn).

Get image variation link

Retrieves a link to an image variation from binary content.

Method signature

String getImageVariationLinkFromBinary( ContentMapbinaryContent, String variation)

String getImageVariationLinkFromBinary( NodebinaryContent, String variation)

Arguments

Argument Description

Argument	Description
`binaryContent`	required Either the ContentMap or the Node of the binary you want to render.
`variation`	optional An image variation defined in the site theme. `original` if you want the original size of the image.

binaryContent

required

Either the ContentMap or the Node of the binary you want to render.

variation

optional

An image variation defined in the site theme.

original if you want the original size of the image.

Returns

String

A link to an image variation.

Usage

imgfn.getImageVariationLinkFromBinary(binaryContent, variation)

[#assign binaryNode = cmsfn.asJCRNode(content).getNode('binaryNodeName')]
[#assign imgLink = imgfn.getImageVariationLinkFromBinary(binaryNode,'original')]
[#assign imgLink240 = imgfn.getImageVariationLinkFromBinary(binaryNode,'240')]

The example above assumes that you have defined an image variation named 240 in your theme.

binaryNodeName is the default name of the subnode that contains the file binary and related information. Use cmsfn to transform this node into a JCR node that can be used in templating function arguments.