One Logo Pool Ball
PaperKit · IOS API REFERENCE

MarkupInteractions

struct · iOS 27.0+ · SDK 27.1

struct MarkupInteractions

Interactions that people can perform on markup elements. Use `MarkupInteractions` to control which actions people can perform on markup elements. By default, all interactions are enabled (`.all`), allowing people to freely select, move, resize, rotate, style, and delete markup. ```swift // Prevent people from deleting markup markup.allowedInteractions = .all.subtracting(.delete) // Allow only selection and moving markup.allowedInteractions = [.select, .move] // Make markup completely read-only markup.allowedInteractions = .readOnly ```

Members (10)

get · iOS 27.0+

all

TypeScript
get all(): MarkupInteractions
Swift declaration
static let all: MarkupInteractions

All interactions enabled (default).

get · iOS 27.0+

move

TypeScript
get move(): MarkupInteractions
Swift declaration
static let move: MarkupInteractions

Allows moving.

get · iOS 27.0+

style

TypeScript
get style(): MarkupInteractions
Swift declaration
static let style: MarkupInteractions

Allows style changes.

get · iOS 27.0+

delete

TypeScript
get delete(): MarkupInteractions
Swift declaration
static let delete: MarkupInteractions

Allows deletion.

get · iOS 27.0+

resize

TypeScript
get resize(): MarkupInteractions
Swift declaration
static let resize: MarkupInteractions

Allows resizing. This only controls manual resizing through direct interaction (drag handles, gestures). Programmatic resizing via the `frame` property always works. For `ShapeMarkup` elements, automatic content-driven resizing from the `autoresizing` property still occurs independently of this setting.

get · iOS 27.0+

rotate

TypeScript
get rotate(): MarkupInteractions
Swift declaration
static let rotate: MarkupInteractions

Allows rotation.

get · iOS 27.0+

select

TypeScript
get select(): MarkupInteractions
Swift declaration
static let select: MarkupInteractions

Allows selection.

init · iOS 27.0+

init

TypeScript
init(rawValue: number): MarkupInteractions
Swift declaration
init(rawValue: Int)

Creates a new option set from the given raw value. This initializer always succeeds, even if the value passed as `rawValue` exceeds the static properties declared as part of the option set. This example creates an instance of `ShippingOptions` with a raw value beyond the highest element, with a bit mask that effectively contains all the declared static members. let extraOptions = ShippingOptions(rawValue: 255) print(extraOptions.isStrictSuperset(of: .all)) // Prints "true" - Parameter rawValue: The raw value of the option set to create. Each bit of `rawValue` potentially represents an element of the option set, though raw values may include bits that are not defined as distinct values of the `OptionSet` type.

get · iOS 27.0+

rawValue

TypeScript
getRawValue($self: MarkupInteractions): number
Swift declaration
let rawValue: Int

The corresponding value of the raw type. A new instance initialized with `rawValue` will be equivalent to this instance. For example: enum PaperSize: String { case A4, A5, Letter, Legal } let selectedSize = PaperSize.Letter print(selectedSize.rawValue) // Prints "Letter" print(selectedSize == PaperSize(rawValue: selectedSize.rawValue)!) // Prints "true"

get · iOS 27.0+

readOnly

TypeScript
get readOnly(): MarkupInteractions
Swift declaration
static let readOnly: MarkupInteractions

Read-only: no interactions enabled.

Skipped declarations

No declarations were skipped in this snapshot.

All PaperKit types →