image

Background image for the Header gadget, if there is one.


image is a member of the Header dictionary.



image has data type image

Image objects are wrappers for URLs which allow the image to be resized.

Metadata

Metadata are implicit properties belonging to a data type. If your data has the name 'foo', you reference it with 'data:foo'. If the metadata is 'bar', you can reference the value of foo's metadata bar with 'data:foo.bar'.

isResizable: true if the image can be resized using the resizeImage operator.
isYoutube: true if the image is a youtube thumbnail.
youtubeMaxResDefaultUrl: URL of the maxresdefault.jpg youtube thumbnail, which exists for HD youtube videos.
width: Width of the image, if specified explicitly, or null.
height: Height of the image, if specified explicitly, or null.

Operators

resizeImage(image, width [, ratio])
Resizes the given image url to the given width (and crops it to the given ratio, if present).
Note: If the image is smaller than the resize width, the image will not be stretched/upscaled.

image: Image, or url of the image, to be resized. e.g. data:post.featuredImage.
width: New width constraint for the image.
ratio (optional): New width:height ratio for the image to be cropped to.

sourceSet(image, widths [, ratio])
Produces a srcset attribute for the given image, resizing the given image to each of the given widths (and cropping them to the given ratio, if present).
Note: If the image is smaller than the resize width, the image will not be stretched/upscaled. This can be problematic when the requested size is larger than the image as the browser will scale it incorrectly.
image: Image, or url of the image, to produce a srcset for. e.g. data:post.featuredImage.
width: Array of new width constraints for the image.
ratio (optional): New width:height ratio for the image to be cropped to.