Namespace: Annotations

Classes

• Annotation
  

  Base annotation type from which all annotations inherit.
• CommentMarkerAnnotation
  

  Root annotation used for comments.
• EllipseAnnotation
  

  Display a ellipse on a page.
• HighlightAnnotation
  

  Highlight markup annotation.
• ImageAnnotation
  

  Display an image annotation, which represent an images in a PDF file.
• InkAnnotation
  

  Display free hand drawings on a page.
• LineAnnotation
  

  Display a straight line on a page.
• LinkAnnotation
  

  Triggers an action when clicked.
• MarkupAnnotation
  

  Base annotation type for all markup annotations.
• MediaAnnotation
  

  Display a media file in a document.
• NoteAnnotation
  

  A text note that will be rendered inside the bounding box.
• PolygonAnnotation
  

  Display a polygon on a page.
• PolylineAnnotation
  

  Display a polyline on a page.
• RectangleAnnotation
  

  Display a rectangle on a page.
• RedactionAnnotation
  

  Mark a region for redaction.
• ShapeAnnotation
  

  Base annotation type for all shape annotations.
• SquiggleAnnotation
  

  Squiggle markup annotation.
• StampAnnotation
  

  Display a stamp annotation, which represent a predefined or customized stamp in a PDF file.
• StrikeOutAnnotation
  

  Strike out markup annotation.
• TextAnnotation
  

  Free form text that will be rendered inside the bounding box.
• UnderlineAnnotation
  

  Underline markup annotation.
• UnknownAnnotation
  

  Unknown or unsupported annotation type.
• WidgetAnnotation
  

  Draw form elements, linked to PSPDFKit.FormFields.FormFields, on a page.

Methods

• (static) fromSerializableObject(annotation) → {AnnotationsUnion}
• (static) rotate(rotation, contentSize nullable) → {PSPDFKit.Annotations.TextAnnotation|PSPDFKit.Annotations.ImageAnnotation|PSPDFKit.Annotations.StampAnnotation}
• (static) toSerializableObject() → {object}

Methods

(static) fromSerializableObject(annotation) → {AnnotationsUnion}

Parameters:

Returns:

Type

AnnotationsUnion

(static) rotate(rotation, contentSizenullable) → {PSPDFKit.Annotations.TextAnnotation|PSPDFKit.Annotations.ImageAnnotation|PSPDFKit.Annotations.StampAnnotation}

Parameters:

Returns:

Type

PSPDFKit.Annotations.TextAnnotation | PSPDFKit.Annotations.ImageAnnotation | PSPDFKit.Annotations.StampAnnotation

Examples

Rotate a text annotation to 110 degrees.

const annotation = new PSPDFKit.Annotations.TextAnnotation({
  text: `This is a test text for rotating
an annotation to 110 degrees.`,
  boundingBox: new PSPDFKit.Geometry.Rect({
    x: 300,
    y: 300,
    width: 246,
    height: 44
  }),
  fontSize: 18,
  font: "Helvetica"
});
const rotatedAnnotation = PSPDFKit.Annotations.rotate(
  annotation,
  110
);
instance.create(rotatedAnnotation.set('pageIndex', 0));

There is an edge case where the original annotation is already rotated by a multiple of 45 degrees. In this case
it's not possible to figure out the dimensions of the content, which will default to a square that fits in the bounding box.
In order to use the correct content dimensions, you can optionally provide a PSPDFKit.Geometry.Size object
that specifies the content's width and height, which should fit in the annotation's bounding box when using the
annotation rotation.

For cases when the original annotation is rotated by any other angle, the content dimensions are calculated automatically,
but you can still provide this object if the annotation's bounding box does not correctly bound the content, so as to obtain
an annotation with a correctly bounding box as a result.

Rotate a 45 degree rotated annotation to 60 degrees.

const rotated45Annotation = new PSPDFKit.Annotations.TextAnnotation({
  text: `This is a test text for a 45
degree rotated text annotation.`,
  rotation: 45,
  boundingBox: new PSPDFKit.Geometry.Rect({
    x: 300,
    y: 300,
    width: 348,
    height: 348
  }),
  fontSize: 18,
  font: "Helvetica"
});
const rotated60Annotation = PSPDFKit.Annotations.rotate(
  rotated45Annotation,
  60,
  new PSPDFKit.Geometry.Size({ width: 246, height: 44 })
);
instance.create(rotated60Annotation.set('pageIndex', 0));

This helper does not check if the resulting rotated annotation overflows the page limits.

(static) toSerializableObject() → {object}

Parameters:

Returns:

Type

object