PaperKit · IOS API REFERENCE

MarkupAdornment

struct · iOS 27.0+ · SDK 27.1

struct MarkupAdornment

A visual adornment that appears on top of markup content within a markup view controller. You use a markup adornment to display an image-based overlay that you can position and configure to enhance markup content. Adornments scale with the zoom level or remain a fixed size in the base coordinate system.

Members (11)

get · iOS 27.0+

dragRegion

TypeScript

get dragRegion(): MarkupAdornment_DragRegion

Swift declaration

var dragRegion: MarkupAdornment.DragRegion

The constraints that define where a person can drag this adornment. - `.fixed`: A person cannot move the adornment. - `.canvas`: A person can move the adornment freely within the canvas.

set · iOS 27.0+

dragRegion

TypeScript

set dragRegion(value: MarkupAdornment_DragRegion)

Swift declaration

var dragRegion: MarkupAdornment.DragRegion

The constraints that define where a person can drag this adornment. - `.fixed`: A person cannot move the adornment. - `.canvas`: A person can move the adornment freely within the canvas.

get · iOS 27.0+

scalesWithZoom

TypeScript

get scalesWithZoom(): boolean

Swift declaration

var scalesWithZoom: Bool

A Boolean value that indicates whether the adornment scales with the zoom level or remains fixed in the base coordinate system. When this value is `true`, the adornment image adjusts to the zoom scale of the `PaperMarkupViewController`. When `false`, the adornment image remains fixed in the base coordinate system.

set · iOS 27.0+

scalesWithZoom

TypeScript

set scalesWithZoom(value: boolean)

Swift declaration

var scalesWithZoom: Bool

get · iOS 27.0+

imageConfiguration

TypeScript

get imageConfiguration(): MarkupAdornment_ImageConfiguration

Swift declaration

var imageConfiguration: MarkupAdornment.ImageConfiguration

The image to display as the adornment.

set · iOS 27.0+

imageConfiguration

TypeScript

set imageConfiguration(value: MarkupAdornment_ImageConfiguration)

Swift declaration

var imageConfiguration: MarkupAdornment.ImageConfiguration

The image to display as the adornment.

get · iOS 27.0+

id

TypeScript

get id(): string

Swift declaration

var id: UUID

A unique identifier for this adornment.

set · iOS 27.0+

id

TypeScript

set id(value: string)

Swift declaration

var id: UUID

A unique identifier for this adornment.

init · iOS 27.0+

init

TypeScript

static init(id: string, anchor: MarkupAdornment_Anchor, imageConfiguration?: MarkupAdornment_ImageConfiguration, dragRegion?: MarkupAdornment_DragRegion, scalesWithZoom?: boolean): MarkupAdornment

Swift declaration

init(id: UUID = UUID(), anchor: MarkupAdornment.Anchor, imageConfiguration: MarkupAdornment.ImageConfiguration = .default, dragRegion: MarkupAdornment.DragRegion = .canvas, scalesWithZoom: Bool = false)

Creates a new markup adornment with the specified configuration. - Parameters: - id: A unique identifier for the adornment. Defaults to a new UUID. - anchor: The positioning anchor that determines where the adornment appears. - imageConfiguration: The visual configuration for the adornment image. Defaults to a pin icon. - dragRegion: The movement constraints for the adornment. Defaults to draggable within the canvas. - scalesWithZoom: A Boolean value that indicates whether the adornment scales with the zoom level. Defaults to `false`.

get · iOS 27.0+

anchor

TypeScript

get anchor(): MarkupAdornment_Anchor

Swift declaration

var anchor: MarkupAdornment.Anchor

The anchor that positions the adornment.

set · iOS 27.0+

anchor

TypeScript

set anchor(value: MarkupAdornment_Anchor)

Swift declaration

var anchor: MarkupAdornment.Anchor

The anchor that positions the adornment.

Skipped declarations

No declarations were skipped in this snapshot.

All PaperKit types →