2021.3 release notes

PSPDFKit for Web 2021.3 renames a series of APIs that contained “ink signature” as part of their names in favor of more generic “signature” definitions:

  • The NutrientViewer.Configuration#populateInkSignatures option was renamed to NutrientViewer.Configuration#populateStoredSignatures.
  • The NutrientViewer.Instance#getInkSignatures method was renamed to NutrientViewer.Instance#getStoredSignatures.
  • The NutrientViewer.Instance#setInkSignatures method was renamed to NutrientViewer.Instance#setStoredSignatures.
  • The NutrientViewer.InteractionMode.INK_SIGNATURE value was renamed to NutrientViewer.InteractionMode.SIGNATURE.
  • The inkSignatures.create, inkSignatures.update, inkSignatures.delete, and inkSignatures.change events were renamed to storedSignatures.create, storedSignatures.update, storedSignatures.delete, and storedSignatures.change.
  • The ink-signature toolbar item, which was part of NutrientViewer.defaultToolbarItems, was renamed to signature.

All of the former APIs will keep working as expected, but a warning will be logged into the console when used. Migrate to the new names since the deprecated ones will be removed as part of the next major release.

Signature APIs that previously only supported ink annotations now also support image annotations:

  • NutrientViewer.Configuration#populateStoredSignatures and NutrientViewer.Instance#setStoredSignatures now also support using NutrientViewer.Annotation.ImageAnnotation instances, along with NutrientViewer.Annotation.InkAnnotation ones. They’ll also be presented on the signature picking UI.
  • NutrientViewer.Instance#getStoredSignatures can return NutrientViewer.Annotation.ImageAnnotation instances in addition to NutrientViewer.Annotation.InkAnnotation ones.
  • The storedSignatures.create, storedSignatures.update, and storedSignatures.delete events can return NutrientViewer.Annotation.ImageAnnotationinstances in addition to NutrientViewer.Annotation.InkAnnotation ones.

For a full list of changes, check out the changelog.

Migrate PSPDFKit Server

If you use PSPDFKit Server, make sure you read the 2021.3 server migration guide.