PaperMarkup

featureSet

get featureSet(): FeatureSet

var featureSet: FeatureSet { get }

The set of features used by this data model.

subelements

get subelements(): MarkupOrderedSet

var subelements: MarkupOrderedSet { get set }

The subelements of the paper markup. Includes shapes, images, strokes, etc.

subelements

set subelements(value: MarkupOrderedSet)

var subelements: MarkupOrderedSet { get set }

The subelements of the paper markup. Includes shapes, images, strokes, etc.

insertNewLine

insertNewLine(configuration: ShapeConfiguration, start: { x: number; y: number }, end: { x: number; y: number }, lineStartMarker?: boolean, lineEndMarker?: boolean): void

mutating func insertNewLine(configuration: ShapeConfiguration, from start: CGPoint, to end: CGPoint, startMarker lineStartMarker: Bool = false, endMarker lineEndMarker: Bool = false)

Add a line element on top of the paper. - Parameters: - configuration: The configuration of the line to insert. - start: The start position of the line. - end: The end position of the line. - lineStartMarker: True if the start of the line has a marker / arrow. - lineEndMarker: True if the end of the line has a marker / arrow.

insertNewImage

insertNewImage(image: _CoreGraphics_CGImage, frame: { x: number; y: number; width: number; height: number }, rotation?: number): void

mutating func insertNewImage(_ image: CGImage, frame: CGRect, rotation: CGFloat = 0)

Add a new image on top of the paper. - Parameters: - image: The image to add. - frame: The frame to add the image at. - rotation: The rotation in radians to add the element with.

insertNewShape

insertNewShape(configuration: ShapeConfiguration, frame: { x: number; y: number; width: number; height: number }, rotation?: number): void

mutating func insertNewShape(configuration: ShapeConfiguration, frame: CGRect, rotation: CGFloat = 0)

Add a new element on top of the paper. - Parameters: - configuration: The configuration of the shape to insert. - frame: The frame to add the element at. - rotation: The rotation in radians to add the element with.

backgroundColor

get backgroundColor(): (_CoreGraphics_CGColor) | null

var backgroundColor: CGColor? { get set }

The background color of the paper. Default is `nil`, which uses a default color based on the current user interface style.

backgroundColor

set backgroundColor(value: (_CoreGraphics_CGColor) | null)

var backgroundColor: CGColor? { get set }

The background color of the paper. Default is `nil`, which uses a default color based on the current user interface style.

indexableContent

get indexableContent(): Promise<(string) | null>

var indexableContent: String? { get async }

insertNewTextbox

insertNewTextboxAttributedTextFrameRotation(attributedText: _Foundation_AttributedString, frame: { x: number; y: number; width: number; height: number }, rotation?: number): void

mutating func insertNewTextbox(attributedText: AttributedString, frame: CGRect, rotation: CGFloat = 0)

Add a new text box on top of the paper. - Parameters: - attributedText: The text inside the element. - frame: The frame to add the element at. - rotation: The rotation in radians to add the element with.

insertNewTextbox

insertNewTextboxAttributedTextFrameRotation68161(attributedText: _Foundation_NSAttributedString, frame: { x: number; y: number; width: number; height: number }, rotation?: number): void

mutating func insertNewTextbox(attributedText: NSAttributedString, frame: CGRect, rotation: CGFloat = 0)

Add a new text box on top of the paper. - Parameters: - attributedText: The text inside the element. - frame: The frame to add the element at. - rotation: The rotation in radians to add the element with.

transformContent

transformContent(transform: _CoreFoundation_CGAffineTransform): void

mutating func transformContent(_ transform: CGAffineTransform)

Transforms the contents of this paper with the specified transform. - Parameters: - transform: The transform applied to the contents of this paper. Skew is ignored.

dataRepresentation

dataRepresentation(): Promise<ArrayBuffer>

func dataRepresentation() async throws -> Data

Generate a serialized data representation of the data model. - Returns: A new serialized data containing a representation of the paper.

init

static initDataRepresentation(dataRepresentation: ArrayBuffer): PaperMarkup

init(dataRepresentation: Data) throws

Initializes and returns a new paper model from the specified data. - Parameter dataRepresentation: The data containing the serialized paper model.

contentsRenderFrame

get contentsRenderFrame(): { x: number; y: number; width: number; height: number }

var contentsRenderFrame: CGRect { get }

The frame that tightly fits the rendered contents on the paper. This frame includes padding around `contentsFrame` to ensure it includes all the rendered aspects of the content. For example, this frame will include the strokes, and shadows of any contents.

removeContentUnsupported

removeContentUnsupported(featureSet: FeatureSet): void

mutating func removeContentUnsupported(by featureSet: FeatureSet)

Remove all contents that is not supported by the provided feature set. - Parameter featureSet: The feature set to limit this data model to. After calling this method `featureSet.isSubset(of: features)` will be `true`.

id

get id(): MarkupID<PaperMarkup>

var id: MarkupID<PaperMarkup> { get set }

The unique identifier of the markup.

id

set id(value: MarkupID<PaperMarkup>)

var id: MarkupID<PaperMarkup> { get set }

The unique identifier of the markup.

draw

draw(context: _CoreGraphics_CGContext, frame: { x: number; y: number; width: number; height: number }, options?: RenderingOptions): Promise<void>

nonisolated(nonsending) func draw(in context: CGContext, frame: CGRect, options: RenderingOptions = RenderingOptions()) async

Draws the entire paper contents in the specified rectangle. - Parameters: - context: The graphics context to render into. - frame: The rectangle (in the coordinate system of the graphics context) in which to draw the paper. - options: The rendering options. To draw a cropped portion of a paper data model, modify the `bounds` of the paper being drawn.

append

appendContentsOf(drawing: _PencilKit_PKDrawing): void

mutating func append(contentsOf drawing: PKDrawing)

Adds the contents of a PencilKit drawing on top of this paper. - Parameters: - drawing: The drawing whose contents is added on top of this paper.

append

appendContentsOf77581(other: PaperMarkup): void

mutating func append(contentsOf other: PaperMarkup)

Adds the contents of a data model on top of this paper. - Parameters: - other: The data model whose contents is added on top of this paper.

init

static initBounds(bounds: { x: number; y: number; width: number; height: number }): PaperMarkup

init(bounds: CGRect)

Initializes and returns a new paper model with the specified bounds. - Parameters: - bounds: The bounds of the markup container.

bounds

get bounds(): { x: number; y: number; width: number; height: number }

var bounds: CGRect { get set }

The bounds of the paper. The contents of the paper are positioned relative to its bounds.

bounds

set bounds(value: { x: number; y: number; width: number; height: number })

var bounds: CGRect { get set }

The bounds of the paper. The contents of the paper are positioned relative to its bounds.