nutrient/com.pspdfkit.annotations/CircleAnnotation

CircleAnnotation

open class CircleAnnotation : ShapeAnnotation

Represents a circle on the page.

Constructors

CircleAnnotation

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

Creates a new circle annotation.

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

Creates a measurement elliptical 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(): CircleAnnotation

Placeholder getCopy method. This is overwritten by each annotation type.

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.