Support and Documentation

Available properties

The following table lists the available properties when defining an image size.

Table 53. Keys for image size

Key

Description

Type

width

Width of rendered image in web page and generated image representation in Styleguide.

Number

height

Height of rendered image in web page and generated image representation in Styleguide.

Number

previewWidth

If width not set, width of image representation in Styleguide. Do not set previewWidth if width is set.

Number

previewHeight

If height not set, height of image representation in Styleguide. Do not set previewHeight if height is set.

Number

maximumWidth

Maximum width of image size. Aspect ratio will be preserved by the resize. If you define maximumWidth, you must also define previewWidth; otherwise, you will get an error.

Number

maximumHeight

Maximum height of image size. Aspect ratio will be preserved by the resize. If you define maximumHeight, you must also define previewHeight; otherwise, you will get an error.

Number

srcsetDescriptors

A list of image density or width descriptors to support different device screen resolutions. For more information, see srcSetDescriptors.

Array of String

format

Specifies the format in which an image is delivered to the client. For more information, see Image format.

String

group

Heading under which an image size appears in the Image Editor. For more information, see Grouping aspect ratios in the image editor.

String

displayName

Customized label for an image size in the image editor. For more information, see Image size display names.

String

quality

Specifies an image's visual quality and compression level at run time.

Number