The style with which to display the image for this `DisplayRepresentation`.
Note that these are only used when an image, not a symbol name, is
specified. When symbol names are specified, they are rendered automatically
as appropriate for the system.
Members (2)
get · iOS 17.0+
default
TypeScript
static get default(): DisplayRepresentation_Image_DisplayStyle
Swift declaration
static var `default`: DisplayRepresentation.Image.DisplayStyle { get }
Display this representation in the default style.
You don't need to explicitly specify this since it is the default.
This rendering style is appropriate, for example,
for thumbnails generated by your app representing
user generated content such as files or notes.
When using this style, provide a full-bleed image, and the system
will render it while respecting the aspect ratio.
get · iOS 17.0+
circular
TypeScript
static get circular(): DisplayRepresentation_Image_DisplayStyle
Swift declaration
static var circular: DisplayRepresentation.Image.DisplayStyle { get }
Display this representation in a circle.
Use this for situations where an entity is represented within
your app as a circle, such as the colorful circles that are
used to represent destinations in Apple Maps.
When using this style, provide a full-bleed image, and the system
will attempt to render your image within a circle mask when possible.