PaperKit · IOS API REFERENCE

ShapeMarkup.Shape

enum · iOS 27.0+ · SDK 27.1

enum Shape

Members (10)

static · iOS 27.0+

arrowShape

TypeScript

static arrowShape(cornerPoint: { x: number; y: number }): ShapeMarkup_Shape

Swift declaration

static func arrowShape(cornerPoint: CGPoint) -> ShapeMarkup.Shape

An arrow shape pointing in a specific direction. - Parameter cornerPoint: The location of the arrow's corner (where the two sides meet) in unit coordinate space.

static · iOS 27.0+

chatBubble

TypeScript

static chatBubble(tailLocation: { x: number; y: number }, tailAngle: number): ShapeMarkup_Shape

Swift declaration

static func chatBubble(tailLocation: CGPoint, tailAngle: CGFloat) -> ShapeMarkup.Shape

A speech bubble with a tail pointing to a specific location. - Parameters: - tailLocation: The position of the tail tip in unit coordinate space. - tailAngle: The angle of the tail in radians.

static · iOS 27.0+

regularPolygon

TypeScript

static regularPolygon(sides: number): ShapeMarkup_Shape

Swift declaration

static func regularPolygon(sides: Int) -> ShapeMarkup.Shape

A regular polygon with equal sides and angles. - Parameter sides: The number of sides.

static · iOS 27.0+

roundedRectangle

TypeScript

static roundedRectangle(cornerRadius: number): ShapeMarkup_Shape

Swift declaration

static func roundedRectangle(cornerRadius: CGFloat) -> ShapeMarkup.Shape

A rectangle with rounded corners. - Parameter cornerRadius: The corner radius in unit coordinate space (0.0 to 1.0). A value of `0.1` represents 10% of the minimum dimension of the shape.

get · iOS 27.0+

configurationType

TypeScript

get configurationType(): ShapeConfiguration_Shape

Swift declaration

var configurationType: ShapeConfiguration.Shape { get }

The category of shape.

init · iOS 27.0+

init

TypeScript

static init(configurationType: ShapeConfiguration_Shape): ShapeMarkup_Shape

Swift declaration

init(configurationType: ShapeConfiguration.Shape)

Creates a default shape for a category of shape.

get · iOS 27.0+

supportsLineMarkers

TypeScript

get supportsLineMarkers(): boolean

Swift declaration

var supportsLineMarkers: Bool { get }

True if this shape supports the addition of line markers.

static · iOS 27.0+

line

TypeScript

static line(start: { x: number; y: number }, control: ({ x: number; y: number }) | null, end: { x: number; y: number }): ShapeMarkup_Shape

Swift declaration

static func line(start: CGPoint, control: CGPoint? = nil, end: CGPoint) -> ShapeMarkup.Shape

A quadratic Bézier curve line. - Parameters: - start: The starting point in unit coordinate space. - control: The control point that defines the curve in unit coordinate space. Defaults to `nil` which creates a straight line without a middle control point. - end: The ending point in unit coordinate space.

get · iOS 27.0+

path

TypeScript

get path(): _CoreGraphics_CGPath

Swift declaration

var path: CGPath { get }

The path of the shape.

static · iOS 27.0+

star

TypeScript

static star(points: number, innerRadius: number): ShapeMarkup_Shape

Swift declaration

static func star(points: Int, innerRadius: CGFloat) -> ShapeMarkup.Shape

A star shape with alternating inner and outer points. - Parameters: - points: The number of points on the star. - innerRadius: The radius of inner points relative to outer points, in unit coordinate space (0.0 to 1.0). A value of `0.5` creates inner points halfway to the center.

Skipped declarations

3 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.

ShapeMarkup.Shape.rectangle

The iOS SDK compiler rejected this binding: ambiguous use of 'rectangle'

ShapeMarkup.Shape.ellipse

The iOS SDK compiler rejected this binding: ambiguous use of 'ellipse'

ShapeMarkup.Shape.star

The iOS SDK compiler rejected this binding: ambiguous use of 'star'

All PaperKit types →