Skip to main content
Browse Documentation

Image

Created by Alex Pop, last modified by Simon Horan on 22 Jan 2020

An image type is a container of an image asset with an associated caption and alt text.

Properties

Name Type Format Description
asset object Asset The asset that is linked to from the entry
altText string The image alt text, defined in the entry
caption string The image caption, defined in the entry
transformations object ImageTransformations The transformations that will be applied to the image

Note The caption property allows instance specific text to be associated with a linked image asset.

Example

{
    "asset": {
        "sys": {
            "id": "a83c9fcc-51ef-41aa-878f-af5a33ba4b2f",
            "dataFormat": "asset",
            "language": "en-GB"
        }
    },
    "caption": "Fight club is a great film!",
    "altText": "The 1999 Fight Club image poster",
    "transformations": {  
        "size": {  
            "height": 100,
            "width": 100
        },
        "flip": "h",
        "rotate": 95,
        "crop": {  
            "width": 100,
            "height": 100,
            "x": 10,
            "y": 20
        },
        "quality": 95
    }
}