PaperMarkupViewController

toolPickerIsRulerActiveDidChange

toolPickerIsRulerActiveDidChange(toolPicker: _PencilKit_PKToolPicker): Promise<void>

@MainActor @preconcurrency func toolPickerIsRulerActiveDidChange(_ toolPicker: PKToolPicker)

toolPickerSelectedToolItemDidChange

toolPickerSelectedToolItemDidChange(toolPicker: _PencilKit_PKToolPicker): Promise<void>

@MainActor @preconcurrency func toolPickerSelectedToolItemDidChange(_ toolPicker: PKToolPicker)

viewDidLoad

viewDidLoad(): Promise<void>

@MainActor @preconcurrency override dynamic func viewDidLoad()

canBecomeFirstResponder

get canBecomeFirstResponder(): Promise<boolean>

@MainActor @preconcurrency override dynamic var canBecomeFirstResponder: Bool { get }

undoManager

get undoManager(): Promise<(_Foundation_UndoManager) | null>

@MainActor @preconcurrency override dynamic var undoManager: UndoManager? { get }

markupEditViewController

markupEditViewControllerInsertNewShape(markupEditViewController: MarkupEditViewController, type: ShapeConfiguration_Shape): Promise<void>

@MainActor @preconcurrency func markupEditViewController(_ markupEditViewController: MarkupEditViewController, insertNewShape type: ShapeConfiguration.Shape)

Add a new shape on top of the paper. - Parameters: - markupEditViewController: The source of the action. - type: The type of shape.

markupEditViewController

markupEditViewControllerInsertNewContents(markupEditViewController: MarkupEditViewController, toInsert: PaperMarkup): Promise<void>

@MainActor @preconcurrency func markupEditViewController(_ markupEditViewController: MarkupEditViewController, insertNewContents toInsert: PaperMarkup)

Add new content on top of the paper. - Parameters: - markupEditViewController: The source of the action. - toInsert: The markup whose contents is added on top of this paper. This is used for inserting any custom content, and non-shape elements like signatures or loupes.

markupEditViewController

markupEditViewControllerInsertNewLineWithStartMarkerEndMarker(markupEditViewController: MarkupEditViewController, lineStartMarker: boolean, lineEndMarker: boolean): Promise<void>

@MainActor @preconcurrency func markupEditViewController(_ markupEditViewController: MarkupEditViewController, insertNewLineWithStartMarker lineStartMarker: Bool, endMarker lineEndMarker: Bool)

Add a new line on top of the paper. - Parameters: - markupEditViewController: The source of the action. - lineStartMarker: True if the start of the line has a marker / arrow. - lineEndMarker: True if the end of the line has a marker / arrow.

markupEditViewControllerInsertNewTextbox

markupEditViewControllerInsertNewTextbox(markupEditViewController: MarkupEditViewController): Promise<void>

@MainActor @preconcurrency func markupEditViewControllerInsertNewTextbox(_ markupEditViewController: MarkupEditViewController)

Add a new textbox on top of the paper. - Parameters: - markupEditViewController: The source of the action.

contentView

get contentView(): Promise<(_UIKit_UIView) | null>

@MainActor @preconcurrency var contentView: UIView? { get set }

The content that markup appears on top of. The system sizes the content view to the frame of the markup and adds it below all the markup and drawing. When `nil`, markup appears on top of a blank white canvas. Default is `nil`.

contentView

setContentView(value?: (_UIKit_UIView) | null): Promise<void>

@MainActor @preconcurrency var contentView: UIView? { get set }

The content that markup appears on top of. The system sizes the content view to the frame of the markup and adds it below all the markup and drawing. When `nil`, markup appears on top of a blank white canvas. Default is `nil`.

selectedMarkup

get selectedMarkup(): Promise<PaperMarkup>

@MainActor @preconcurrency var selectedMarkup: PaperMarkup { get set }

The selected contents in the UI.

selectedMarkup

setSelectedMarkup(value: PaperMarkup): Promise<void>

@MainActor @preconcurrency var selectedMarkup: PaperMarkup { get set }

The selected contents in the UI.

adornments

get adornments(): Promise<Array<MarkupAdornment>>

@MainActor @preconcurrency var adornments: [MarkupAdornment] { get set }

An array of visual adornments that appear on the markup canvas. Adornments are supplementary visual elements you place on the canvas above the primary markup content. You position adornments using anchor points and configure them to respond to interaction, zoom scaling, and movement. - Note: Adornments are expected to have unique IDs. If two or more adornments have the same ID, the system displays only one.

adornments

setAdornments(value: Array<MarkupAdornment>): Promise<void>

@MainActor @preconcurrency var adornments: [MarkupAdornment] { get set }

An array of visual adornments that appear on the markup canvas. Adornments are supplementary visual elements you place on the canvas above the primary markup content. You position adornments using anchor points and configure them to respond to interaction, zoom scaling, and movement. - Note: Adornments are expected to have unique IDs. If two or more adornments have the same ID, the system displays only one.

isEditable

get isEditable(): Promise<boolean>

@MainActor @preconcurrency var isEditable: Bool { get set }

A Boolean value that indicates whether a person can edit the canvas contents. This property controls whether a person can edit content. The default value is `true`. Coordinate this property with your `MarkupEditViewController` or `MarkupToolbarViewController` to prevent people from adding new canvas elements.

isEditable

setIsEditable(value: boolean): Promise<void>

@MainActor @preconcurrency var isEditable: Bool { get set }

A Boolean value that indicates whether a person can edit the canvas contents. This property controls whether a person can edit content. The default value is `true`. Coordinate this property with your `MarkupEditViewController` or `MarkupToolbarViewController` to prevent people from adding new canvas elements.

drawingTool

get drawingTool(): Promise<SDKHandle>

@MainActor @preconcurrency var drawingTool: any PKTool { get set }

The tool for drawing on the canvas. When a touch is a drawing interaction, the canvas uses this tool to draw. Default is `PKInkingTool(.pen)`.

drawingTool

setDrawingTool(value: Implements<_PencilKit_PKTool> | SDKHandle): Promise<void>

@MainActor @preconcurrency var drawingTool: any PKTool { get set }

The tool for drawing on the canvas. When a touch is a drawing interaction, the canvas uses this tool to draw. Default is `PKInkingTool(.pen)`.

isRulerActive

get isRulerActive(): Promise<boolean>

@MainActor @preconcurrency var isRulerActive: Bool { get set }

A Boolean value that indicates whether a ruler view is visible on the canvas.

isRulerActive

setIsRulerActive(value: boolean): Promise<void>

@MainActor @preconcurrency var isRulerActive: Bool { get set }

A Boolean value that indicates whether a ruler view is visible on the canvas.

adornmentFrame

adornmentFrame(id: string): Promise<({ x: number; y: number; width: number; height: number }) | null>

@MainActor @preconcurrency func adornmentFrame(for id: UUID) -> CGRect?

Returns the current frame of the specified adornment. This method calculates the visual frame of an adornment based on its anchor position, image size, attachment point, zoom scale and content offset. - Parameter id: The ID of the `MarkupAdornment` whose frame you want to retrieve. - Returns: The frame of the adornment in the coordinate system of this view controller's view, or `nil` if the canvas does not display the adornment or cannot determine its frame.

directTouchMode

get directTouchMode(): Promise<PaperMarkupViewController_TouchMode>

@MainActor @preconcurrency var directTouchMode: PaperMarkupViewController.TouchMode { get set }

The interaction mode for direct touches on the canvas. To control automatic behavior for direct touches based on system state, see `directTouchAutomaticallyDraws`. Default is `.selection`.

directTouchMode

setDirectTouchMode(value: PaperMarkupViewController_TouchMode): Promise<void>

@MainActor @preconcurrency var directTouchMode: PaperMarkupViewController.TouchMode { get set }

The interaction mode for direct touches on the canvas. To control automatic behavior for direct touches based on system state, see `directTouchAutomaticallyDraws`. Default is `.selection`.

contentVisibleFrame

get contentVisibleFrame(): Promise<{ x: number; y: number; width: number; height: number }>

@MainActor @preconcurrency var contentVisibleFrame: CGRect { get set }

The visible area of content in the scroll view. Modifying this property immediately moves the canvas, to animate changing the visible rect use ``setContentVisibleFrame(_:animated:)``.

contentVisibleFrame

setContentVisibleFrame(value: { x: number; y: number; width: number; height: number }): Promise<void>

@MainActor @preconcurrency var contentVisibleFrame: CGRect { get set }

The visible area of content in the scroll view. Modifying this property immediately moves the canvas, to animate changing the visible rect use ``setContentVisibleFrame(_:animated:)``.

scrollConfiguration

get scrollConfiguration(): Promise<PaperMarkupViewController_ScrollConfiguration>

@MainActor @preconcurrency var scrollConfiguration: PaperMarkupViewController.ScrollConfiguration { get }

The configuration object that provides access to scroll view functionality.

supportedFeatureSet

get supportedFeatureSet(): Promise<FeatureSet>

@MainActor @preconcurrency var supportedFeatureSet: FeatureSet { get }

The supported PaperKit features on this canvas.

setContentVisibleFrame

setContentVisibleFrame66674(rect: { x: number; y: number; width: number; height: number }, animated: boolean): Promise<void>

@MainActor @preconcurrency func setContentVisibleFrame(_ rect: CGRect, animated: Bool)

Zooms to a specific area of the content so that it’s visible in the scroll view. - Parameters: - rect: A rectangle defining an area of the content view. The rectangle should be in the coordinate space of the data model. - animated: `true` if the scrolling should be animated, `false` if it should be immediate. This method scrolls the content so that the area defined by rect is just visible. If the area is already visible, the method does nothing.

indirectPointerTouchMode

get indirectPointerTouchMode(): Promise<PaperMarkupViewController_TouchMode>

@MainActor @preconcurrency var indirectPointerTouchMode: PaperMarkupViewController.TouchMode { get set }

The interaction mode for indirect pointer touches on the canvas. Default is `.selection`.

indirectPointerTouchMode

setIndirectPointerTouchMode(value: PaperMarkupViewController_TouchMode): Promise<void>

@MainActor @preconcurrency var indirectPointerTouchMode: PaperMarkupViewController.TouchMode { get set }

The interaction mode for indirect pointer touches on the canvas. Default is `.selection`.

suggestedFrameForInserting

suggestedFrameForInserting(frame: { x: number; y: number; width: number; height: number }): Promise<{ x: number; y: number; width: number; height: number }>

@MainActor @preconcurrency func suggestedFrameForInserting(contentInFrame frame: CGRect) -> CGRect

Returns the suggested frame for inserting shapes and other content. - Parameters: - frame: The frame of the content you want to insert. - Returns: The suggested frame for the content. Use this value to transform a `PaperMarkup` before inserting it. ```swift var shapeFrame = CGRect(x: 100, y: 100, width: 300, height: 300) // Get the default frame for inserting, and insert the shape there. let suggestedFrame = paperViewController.suggestedFrameForInserting(contentInFrame: shapeFrame) paperViewController.markup.insertNewShape(configuration: shapeConfiguration, frame: suggestedFrame) ```

showsVerticalScrollIndicator

get showsVerticalScrollIndicator(): Promise<boolean>

@MainActor @preconcurrency var showsVerticalScrollIndicator: Bool { get set }

A Boolean value that controls whether the vertical scroll indicator is visible. Default is `true`.

showsVerticalScrollIndicator

setShowsVerticalScrollIndicator(value: boolean): Promise<void>

@MainActor @preconcurrency var showsVerticalScrollIndicator: Bool { get set }

A Boolean value that controls whether the vertical scroll indicator is visible. Default is `true`.

directTouchAutomaticallyDraws

get directTouchAutomaticallyDraws(): Promise<boolean>

@MainActor @preconcurrency var directTouchAutomaticallyDraws: Bool { get set }

A Boolean value that indicates whether direct touches automatically draw based on system state. Direct touches on the canvas behave as if `directTouchMode = .drawing` when `directTouchAutomaticallyDraws` is true, a `PKToolPicker` is visible, and the "Draw with Finger" system setting is on. Default is `true`.

directTouchAutomaticallyDraws

setDirectTouchAutomaticallyDraws(value: boolean): Promise<void>

@MainActor @preconcurrency var directTouchAutomaticallyDraws: Bool { get set }

A Boolean value that indicates whether direct touches automatically draw based on system state. Direct touches on the canvas behave as if `directTouchMode = .drawing` when `directTouchAutomaticallyDraws` is true, a `PKToolPicker` is visible, and the "Draw with Finger" system setting is on. Default is `true`.

showsHorizontalScrollIndicator

get showsHorizontalScrollIndicator(): Promise<boolean>

@MainActor @preconcurrency var showsHorizontalScrollIndicator: Bool { get set }

A Boolean value that controls whether the horizontal scroll indicator is visible. Default is `true`.

showsHorizontalScrollIndicator

setShowsHorizontalScrollIndicator(value: boolean): Promise<void>

@MainActor @preconcurrency var showsHorizontalScrollIndicator: Bool { get set }

A Boolean value that controls whether the horizontal scroll indicator is visible. Default is `true`.

init

static init(markup: (PaperMarkup) | null, supportedFeatureSet: FeatureSet): Promise<PaperMarkupViewController>

@MainActor @preconcurrency init(markup: PaperMarkup? = nil, supportedFeatureSet: FeatureSet)

Creates a new markup view controller with the provided data model. - Parameters: - markup: The data model to show on this canvas. The default value is `nil`. - supportedFeatureSet: The features this view controller supports. The canvas limits the edits that a person can make so they’re compatible with the feature set specified. If you set a `supportedFeatureSet`, also use a similar feature set to configure any `MarkupToolbarViewController` or `MarkupEditViewController` you use.

markup

get markup(): Promise<(PaperMarkup) | null>

@MainActor @preconcurrency var markup: PaperMarkup? { get set }

The paper data that this view controller displays. Observe `markup` to watch for markup changes.

markup

setMarkup(value?: (PaperMarkup) | null): Promise<void>

@MainActor @preconcurrency var markup: PaperMarkup? { get set }

The paper data that this view controller displays. Observe `markup` to watch for markup changes.

delegate

get delegate(): Promise<(SDKHandle) | null>

@MainActor @preconcurrency weak var delegate: (any PaperMarkupViewController.Delegate)? { get set }

The delegate for responding to a person's actions.

delegate

setDelegate(value?: (SDKHandle) | null): Promise<void>

@MainActor @preconcurrency weak var delegate: (any PaperMarkupViewController.Delegate)? { get set }

The delegate for responding to a person's actions.

selection

get selection(): Promise<Array<MarkupOrderedSet_ElementID>>

@MainActor @preconcurrency var selection: Set<MarkupOrderedSet.ElementID> { get set }

The current selected elements on the canvas.

selection

setSelection(value: Array<MarkupOrderedSet_ElementID>): Promise<void>

@MainActor @preconcurrency var selection: Set<MarkupOrderedSet.ElementID> { get set }

The current selected elements on the canvas.

zoomRange

get zoomRange(): Promise<"animatableData" | SDKHandle>

@MainActor @preconcurrency var zoomRange: ClosedRange<CGFloat> { get set }

A floating-point range that specifies the minimum and maximum scale factor that can apply to the canvas' content. The default value is `1.0...1.0`.

zoomRange

setZoomRange(value: "animatableData" | SDKHandle): Promise<void>

@MainActor @preconcurrency var zoomRange: ClosedRange<CGFloat> { get set }

A floating-point range that specifies the minimum and maximum scale factor that can apply to the canvas' content. The default value is `1.0...1.0`.