Get Started

play_arrow

Learn more

play_arrow

Common use cases

play_arrow

Open a document

play_arrow

Save a document

play_arrow

Viewer

play_arrow

UI Customization

play_arrow

Annotations

play_arrow

Collaboration

play_arrow

Forms

play_arrow

Signature

play_arrow

Measurement

play_arrow

PDF.js Express REST API

play_arrow

Annotations tools

When a user wants to create an annotation, select text or pan around the document they'll use their mouse and keyboard or touch the screen. A tool is just a way of capturing those inputs from the user and doing something in response. Tools automatically funnel user events into handler functions (for example mouseLeftUp, mouseMove, etc) and convert the mouse coordinates into document page coordinates automatically for you.

Annotation tools use the page coordinates to specify annotation properties, like position and dimension. By default, each annotation type has an associated tool, but that doesn't mean a tool can only be associated with one type of annotation. For example, you may have several sticky tools to create sticky annotations with different colors. You can also define a custom annotation and not associate any tool with it, instead creating the annotations programmatically.

Sticky annotation tool

Figure 2. Creating sticky annotation using sticky annotation tool

List of tool names

  • AnnotationEdit
  • TextSelect
  • Pan
  • AnnotationCreateSticky
  • AnnotationCreateFreeHand
  • AnnotationCreateTextHighlight
  • AnnotationCreateTextUnderline
  • AnnotationCreateTextSquiggly
  • AnnotationCreateTextStrikeout
  • AnnotationCreateFreeText
  • AnnotationCreateCallout
  • AnnotationCreateSignature
  • AnnotationCreateLine
  • AnnotationCreateArrow
  • AnnotationCreatePolyline
  • AnnotationCreateStamp
  • AnnotationCreateRectangle
  • AnnotationCreateEllipse
  • AnnotationCreatePolygon
  • AnnotationCreatePolygonCloud
  • AnnotationCreateDistanceMeasurement
  • AnnotationCreatePerimeterMeasurement
  • AnnotationCreateAreaMeasurement