PaperKit · IOS API REFERENCE

MarkupAdornment.ImageConfiguration

struct · SDK 27.1

struct ImageConfiguration

The visual appearance configuration for a markup adornment. An `ImageConfiguration` defines the visual appearance of an adornment, including the image source, size, and alignment anchor point for positioning.

Members (3)

static

systemImage

TypeScript

static systemImage(name: string, tint?: _UIKit_UIColor, size?: ({ width: number; height: number }) | null, alignmentAnchor?: { x: number; y: number }): MarkupAdornment_ImageConfiguration

Swift declaration

static func systemImage(_ name: String, tint: UIColor = .tintColor, size: CGSize? = nil, alignmentAnchor: CGPoint = .zero) -> MarkupAdornment.ImageConfiguration

Creates an image configuration using a system image. - Parameters: - name: The SF Symbol name for the system image. - tint: The color to apply to the image. Defaults to the system tint color. - size: The size of the rendered image in points. Defaults to 48x48. - alignmentAnchor: The offset from the image center for positioning. Defaults to zero. - Returns: An `ImageConfiguration` for the system image.

static

image

TypeScript

static image(image: _UIKit_UIImage, alignmentAnchor?: { x: number; y: number }): MarkupAdornment_ImageConfiguration

Swift declaration

static func image(_ image: UIImage, alignmentAnchor: CGPoint = .zero) -> MarkupAdornment.ImageConfiguration

Creates an image configuration using a custom image. - Parameters: - image: The `UIImage` to display. - alignmentAnchor: The offset from the image center for positioning. Defaults to zero. - Returns: An `ImageConfiguration` for the custom image.

get

default

TypeScript

static get default(): MarkupAdornment_ImageConfiguration

Swift declaration

static let `default`: MarkupAdornment.ImageConfiguration

The default image configuration using a pin-shaped system image.

Skipped declarations

No declarations were skipped in this snapshot.

All PaperKit types →