PencilKit · IOS API REFERENCE

PKToolPickerInkingItem

class · iOS 18.0+ · SDK 27.1

class PKToolPickerInkingItem

Members (5)

get · iOS 18.0+

allowsColorSelection

TypeScript

get allowsColorSelection(): boolean

Swift declaration

var allowsColorSelection: Bool { get set }

set · iOS 18.0+

allowsColorSelection

TypeScript

set allowsColorSelection(value: boolean)

Swift declaration

var allowsColorSelection: Bool { get set }

get · iOS 18.0+

inkingTool

TypeScript

get inkingTool(): PKInkingTool

Swift declaration

var inkingTool: PKInkingTool { get }

A tool for drawing on a PKCanvasView.

init · iOS 18.0+

init

TypeScript

static initTypeColorWidthIdentifier(type: PKInkingTool_InkType, color?: (_UIKit_UIColor) | null, width?: (number) | null, identifier?: (string) | null): PKToolPickerInkingItem

Swift declaration

convenience init(type: PKInkingTool.InkType, color: UIColor? = nil, width: CGFloat? = nil, identifier: String? = nil)

Create a new inking tool item. - Parameters: - type: The ink type for the tool. - color: The color for the tool. Passing `nil` resolves to a default value based on the `InkType`. - width: The width for the tool. Passing `nil` resolves to a default value based on the `InkType`. - identifier: The identifier for the tool item. Passing `nil` resolves to a default value based on the `InkType`.

init · iOS 26.0+

init

TypeScript

static initTypeColorWidthAzimuthIdentifier(type: PKInkingTool_InkType, color?: (_UIKit_UIColor) | null, width?: (number) | null, azimuth?: (number) | null, identifier?: (string) | null): PKToolPickerInkingItem

Swift declaration

convenience init(type: PKInkingTool.InkType, color: UIColor? = nil, width: CGFloat? = nil, azimuth: CGFloat? = nil, identifier: String? = nil)

Create a new inking tool item. - Parameters: - type: The ink type for the tool. - color: The color for the tool. Passing `nil` resolves to a default value based on the `InkType`. - width: The width for the tool. Passing `nil` resolves to a default value based on the `InkType`. - azimuth: The azimuth for the tool. Passing `nil` resolves to a default value based on the `InkType`. - identifier: The identifier for the tool item. Passing `nil` resolves to a default value based on the `InkType`.

Skipped declarations

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

PKToolPickerInkingItem.init()

inherited init: cannot prove legal (class declares 2 custom initializers)

All PencilKit types →