Annotations

Annotations allow users to highlight text and comment on specific areas of a file preview, such as a particular area of an image or on a particular slide of a presentation.

What are annotations?

Annotations allow end users to mark up file previews in the Box web application or any application leveraging Box Content Preview. With annotations, end users can collaborate on a file without having to leave the app or print out files in order to mark up or highlight them.

Annotations allow users to highlight text and comment on specific areas of a file rendering, such as a particular area of an image or on a particular slide of a presentation. Once enabled, your users will see options to add annotations in the header bar of the embedded file viewer using either Box Content Preview or the Get Embed Link endpoint of the Box Content API. You can easily enable annotations by adding a query parameter to the embedded file URL. Annotations are currently optimized for web browsers with limited support for mobile browsers.

Annotation types

There are two types of annotations available:

Point Comments
Point comments allow users to add comments to specific points in a document or image preview. Point comments are stored with the file and displayed to other users of the app. Point comments will display a user's name, text comment, and the date and time of the comment.

Point comment annotations on a Box file preview

Point comment annotations on a Box file preview

Text Highlights
Text highlighting allows users to highlight text in a document preview. Highlights will place a transparent yellow overlay over text in the document and highlighted text will be visible to other users who preview the file.

Text highlighting on a Box file preview

Text highlighting on a Box file preview

Annotations

Annotations allow users to highlight text and comment on specific areas of a file preview, such as a particular area of an image or on a particular slide of a presentation.