nutrient/com.pspdfkit.signatures/Signature

Signature

Represents a single signature (or signature item). To create an Annotation from this signature use the toAnnotation methods. Helper methods to create Ink or Stamp Signatures are here: createStampSignature, createInkSignature.

Types

Companion

object Companion : Parceler<Signature>

Companion object providing factory methods and Parcelable support for Signature.

Properties

biometricData

val biometricData: BiometricSignatureData?

BiometricSignatureData that was collected with this signature. May return null if no biometric data was created.

bitmap

val bitmap: Bitmap?

When creating a stamp signature (as opposed to ink signature), you need to provide a bitmap.

boundingBox

val boundingBox: RectF

The bounding box of the signature data in PDF coordinates. The bounding box will always have its left and bottom values equal 0.

drawWidthRatio

val drawWidthRatio: Float

The ratio of signature width to width of the drawing view used when drawing the signature.

val id: Long

Signature id number used in signature database. If not set, the default value is ID_NOT_SET.

inkColor

@get:ColorInt

val inkColor: Int

Colour of the ink signature

lines

val lines: List<List<PointF>>

List of ink lines in pdf points.

lineWidth

val lineWidth: Float

Signature line width in pdf points.

stampRect

val stampRect: RectF?

Bounding rectangle for this signature's bitmap.

Functions

toAnnotation

fun toAnnotation(@IntRange(from = 0) pageIndex: Int): Annotation

Builds InkAnnotation or StampAnnotation from signature data. If you want to create a stamp annotation with a specific bounding box around certain touch point, use toAnnotation instead.

fun toAnnotation(document: PdfDocument, @IntRange(from = 0) pageIndex: Int, touchPoint: PointF): Annotation

fun toAnnotation(document: PdfDocument, @IntRange(from = 0) pageIndex: Int, targetRect: RectF): Annotation

Builds InkAnnotation or StampAnnotation from signature data.

toJson

fun toJson(): JSONObject

Converts a signature into a JSON object. You can use that JSON object to recreate the signature later on via fromJson.

write

open override fun Signature.write(parcel: Parcel, flags: Int)

Writes the signature data to a Parcel for serialization.