Package-level declarations

Measurement tools APIs.

Types

Link copied to clipboard
Measurement info object contains all the measurement information available in a measurement annotation.
Link copied to clipboard
Measurement mode.
Link copied to clipboard
Number of decimal points for annotation float value rounding.
Link copied to clipboard
class MeasurementValueConfiguration(val name: String?, val scale: Scale, val precision: MeasurementPrecision) : ScaleAndPrecision

Configures a measurement value and consists of a Scale, MeasurementPrecision, and a name for this configuration. These properties describe how the actual measurement value is calculated and formatted for the measurement annotations. The name property is just to have the option to display a user-friendly name in the UI, it has no further use. If we ever check for duplicates, or try to find a specific MeasurementValueConfiguration in the document's configuration list, only scale and precision matter. That being said, the combination of scale and precision needs to be unique - you cannot have two MeasurementValueConfigurations in the document with same scale and precision. The name can be null, in that case the UI shows generated name.

Link copied to clipboard

Interface that allows you to modify the list of MeasurementValueConfigurations stored in the document. You can obtain an instance of it by calling PdfFragment.getMeasurementValueConfigurationEditor

Link copied to clipboard
class Scale

A ratio of the size of an object as displayed on a document page to the size of a corresponding real-world object. Scale objects are used for measurement annotations. This class is immutable - you must create a new Scale object if you want to change any of the members.

Link copied to clipboard
abstract class ScaleAndPrecision

Collects both Scale and Precision into one abstract baseclass. Implements an equals operator

Link copied to clipboard
This class holds the units to be used for the secondary unit(if enabled by the user) and just contains the MeasurementPrecision and the com.pspdfkit.annotations.measurements.Scale.UnitTo.