Page tree

Magnolia 5.7 reached extended end of life on May 31, 2022. Support for this branch is limited, see End-of-life policy. Please note that to cover the extra maintenance effort, this EEoL period is a paid extension in the life of the branch. Customers who opt for the extended maintenance will need a new license key to run future versions of Magnolia 5.7. If you have any questions or to subscribe to the extended maintenance, please get in touch with your local contact at Magnolia.

Image provider is a component that renders images used in apps. It generates the portrait image at the bottom of the action bar and the thumbnails for the thumbnail view. 

Here is an example image provider definition that uses default classes.

imageProvider:
  class: info.magnolia.ui.imageprovider.definition.ConfiguredImageProviderDefinition
  imageProviderClass: info.magnolia.ui.imageprovider.DefaultImageProvider
  originalImageNodeName: jcr:content

Node name

Value

 imageProvider


 class

info.magnolia.ui.imageprovider.definition.ConfiguredImageProviderDefinition

 imageProviderClass

info.magnolia.ui.imageprovider.DefaultImageProvider

 originalImageNodeName

jcr:content

Properties:

class

required

Image provider definition class that reads the configuration properties and can supply additional parameters to the image provider class. The definition class must implement the  ImageProviderDefinition  interface. Set the value to a fully-qualified class name.

imageProviderClass

required

Actual implementation that generates thumbnail images. The class must implement the  ImageProvider  interface. You can use  DefaultImageProvider  which provides images for objects of MIME type image/* and delegates to the Imaging module to generate and store the images.

imageExtension

optional, default is png

Extension used to deliver the image.

imagingServletPath

optional, default is /.imaging

Path where the imaging servlet resides.

originalImageNodeName

optional, default is originalImage

Name of the JCR node where the original source image is stored. For example, if a file upload field on a form stores the image in a node named photo set the value to photo.


Here are the default image generator configurations that DefaultImageProvider  uses. portrait is displayed at the bottom of the action bar and thumbnail in the thumbnail view.

Node name

Value

 modules

 imaging


 config


 generators


 portrait


 outputFormat


 operations


 parameterProviderFactory


 class

info.magnolia.imaging.operations.ImageOperationChain

 thumbnail


 outputFormat


 operations


 parameterProviderFactory


 class

info.magnolia.imaging.operations.ImageOperationChain