<!--
{
  "availability" : [
    "iOS: 27.0.0 -",
    "iPadOS: 27.0.0 -",
    "macOS: 27.0.0 -",
    "visionOS: 27.0.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "PaperKit",
  "identifier" : "/documentation/PaperKit/MarkupAdornment",
  "metadataVersion" : "0.1.0",
  "role" : "Structure",
  "symbol" : {
    "kind" : "Structure",
    "modules" : [
      "PaperKit"
    ],
    "preciseIdentifier" : "s:8PaperKit15MarkupAdornmentV"
  },
  "title" : "MarkupAdornment"
}
-->

# MarkupAdornment

A visual adornment that appears on top of markup content within a markup view controller.

```
struct MarkupAdornment
```

## Overview

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.

## Topics

### Creating an adornment

[`init(id: UUID, anchor: MarkupAdornment.Anchor, imageConfiguration: MarkupAdornment.ImageConfiguration, dragRegion: MarkupAdornment.DragRegion, scalesWithZoom: Bool)`](/documentation/PaperKit/MarkupAdornment/init(id:anchor:imageConfiguration:dragRegion:scalesWithZoom:))

Creates a new markup adornment with the specified configuration.

### Anchoring the adornment

[`struct Anchor`](/documentation/PaperKit/MarkupAdornment/Anchor-swift.struct)

The positioning reference point for an adornment within the markup canvas.

[`var anchor: MarkupAdornment.Anchor`](/documentation/PaperKit/MarkupAdornment/anchor-swift.property)

The anchor that positions the adornment.

### Configuring the image

[`struct ImageConfiguration`](/documentation/PaperKit/MarkupAdornment/ImageConfiguration-swift.struct)

The visual appearance configuration for a markup adornment.

[`var imageConfiguration: MarkupAdornment.ImageConfiguration`](/documentation/PaperKit/MarkupAdornment/imageConfiguration-swift.property)

The image to display as the adornment.

### Controlling interactions

[`struct DragRegion`](/documentation/PaperKit/MarkupAdornment/DragRegion-swift.struct)

The movement behavior and interaction constraints for a markup adornment.

[`var dragRegion: MarkupAdornment.DragRegion`](/documentation/PaperKit/MarkupAdornment/dragRegion-swift.property)

The constraints that define where a person can drag this adornment.

[`var scalesWithZoom: Bool`](/documentation/PaperKit/MarkupAdornment/scalesWithZoom)

A Boolean value that indicates whether the adornment scales with the zoom level or remains fixed in the base coordinate system.

### Identifying markup

[`var id: UUID`](/documentation/PaperKit/MarkupAdornment/id)

A unique identifier for this adornment.

## Relationships

### Conforms To

[`Identifiable`](/documentation/Swift/Identifiable)

[`Hashable`](/documentation/Swift/Hashable)

[`Encodable`](/documentation/Swift/Encodable)

[`Decodable`](/documentation/Swift/Decodable)

[`Escapable`](/documentation/Swift/Escapable)

[`SendableMetatype`](/documentation/Swift/SendableMetatype)

[`Sendable`](/documentation/Swift/Sendable)

[`Copyable`](/documentation/Swift/Copyable)

[`Equatable`](/documentation/Swift/Equatable)

---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)