nutrient/com.pspdfkit.annotations/SquareAnnotation

SquareAnnotation

open class SquareAnnotation : ShapeAnnotation

Represents a square rendered on the page.

Constructors

SquareAnnotation

constructor(@IntRange(from = 0) pageIndex: Int, rect: RectF)

Creates a new square annotation.

constructor(@IntRange(from = 0) pageIndex: Int, rect: RectF, scale: Scale, precision: MeasurementPrecision)

Creates a measurement rectangular area annotation. Will throw an exception if Measurement Tools are not licensed.

Properties

open override val type: AnnotationType

Gets the annotation type of the annotation.

Functions

open override fun getCopy(): SquareAnnotation

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

getMeasurementLabelValue

open override fun getMeasurementLabelValue(measurementProperties: MeasurementProperties): MeasurementLabelValue?

Return the measurement label and value for this annotation if it is a measurement. Returns null if it's not a measurement. Overridden in child shape annotations who can be measurements. Calculates the measurement value based on the passed measurementProperties and shape size.