nutrient/com.pspdfkit.annotations/InkAnnotation

InkAnnotation

open class InkAnnotation : Annotation

Represents a freehand drawing on the page.

Constructors

InkAnnotation

constructor(@IntRange(from = 0) pageIndex: Int)

Creates a new ink annotation.

Types

Companion

object Companion

Constants for InkAnnotation.

Properties

isResizable

open override val isResizable: Boolean

Check if the annotation is resizable, or if this is a non-resizable annotation.

lines

var lines: @JvmSuppressWildcards List<List<PointF>>

List of lines this Ink annotation represents. A line is a list of connected points in PDF coordinates. An ink annotation may have several such disjoint lines of the same color.

lineWidth

var lineWidth: Float

Ink line width/thickness, in PDF points.

type

open override val type: AnnotationType

Gets the annotation type of the annotation.

Functions

getCopy

open override fun getCopy(): InkAnnotation

Gets a copy of this annotation with the page index and object number reset.

setIsSignature

fun setIsSignature(isSignature: Boolean)

Sets whether this annotation is an electronic signature annotation.

updateTransformationProperties

open override fun updateTransformationProperties(newBoundingBox: RectF, oldBoundingBox: RectF)

Annotations may override this method to transform their properties (i.e. points, rects, sizes) whenever the bounding box of the annotation changed.