Resource Base
Table of contents

Annotation

Annotation has eleven main classes:

Rectangle Class

API Name Description
uid Return the uid of the annotation.
pageUid Return the uid of the page where the annotation is located.
creationDate Return the creation date of the annotation.
flattened Flattens the annotation onto the image layer, or inspect if the annotation is flattened.
modificationDate Return the modification date of the annotation.
getOptions() Get the annotation options.
updateOptions() Update the annotation options.

Ellipse Class

API Name Description
uid Return the uid of the annotation.
pageUid Return the uid of the page where the annotation is located.
creationDate Return the creation date of the annotation.
flattened Flattens the annotation onto the image layer, or inspect if the annotation is flattened.
modificationDate Return the modification date of the annotation.
getOptions() Get the annotation options.
updateOptions() Update the annotation options.

Polygon Class

API Name Description
uid Return the uid of the annotation.
pageUid Return the uid of the page where the annotation is located.
creationDate Return the creation date of the annotation.
flattened Flattens the annotation onto the image layer, or inspect if the annotation is flattened.
modificationDate Return the modification date of the annotation.
getOptions() Get the annotation options.
updateOptions() Update the annotation options.

Polyline Class

API Name Description
uid Return the uid of the annotation.
pageUid Return the uid of the page where the annotation is located.
creationDate Return the creation date of the annotation.
flattened Flattens the annotation onto the image layer, or inspect if the annotation is flattened.
modificationDate Return the modification date of the annotation.
getOptions() Get the annotation options.
updateOptions() Update the annotation options.

Line Class

API Name Description
uid Return the uid of the annotation.
pageUid Return the uid of the page where the annotation is located.
creationDate Return the creation date of the annotation.
flattened Flattens the annotation onto the image layer, or inspect if the annotation is flattened.
modificationDate Return the modification date of the annotation.
getOptions() Get the annotation options.
updateOptions() Update the annotation options.

Ink Class

API Name Description
uid Return the uid of the annotation.
pageUid Return the uid of the page where the annotation is located.
creationDate Return the creation date of the annotation.
flattened Flattens the annotation onto the image layer, or inspect if the annotation is flattened.
modificationDate Return the modification date of the annotation.
getOptions() Get the annotation options.
updateOptions() Update the annotation options.

TextBox Class

API Name Description
uid Return the uid of the annotation.
pageUid Return the uid of the page where the annotation is located.
creationDate Return the creation date of the annotation.
flattened Flattens the annotation onto the image layer, or inspect if the annotation is flattened.
modificationDate Return the modification date of the annotation.
getOptions() Get the annotation options.
updateOptions() Update the annotation options.

TextTypewriter Class

API Name Description
uid Return the uid of the annotation.
pageUid Return the uid of the page where the annotation is located.
creationDate Return the creation date of the annotation.
flattened Flattens the annotation onto the image layer, or inspect if the annotation is flattened.
modificationDate Return the modification date of the annotation.
getOptions() Get the annotation options.
updateOptions() Update the annotation options.

Stamp Class

API Name Description
uid Return the uid of the annotation.
pageUid Return the uid of the page where the annotation is located.
creationDate Return the creation date of the annotation.
flattened Flattens the annotation onto the image layer, or inspect if the annotation is flattened.
modificationDate Return the modification date of the annotation.
getOptions() Get the annotation options.
updateOptions() Update the annotation options.

Incomplete Class

API Name Description
uid Return the uid of the annotation.
pageUid Return the uid of the page where the annotation is located.
flattened Flattens the annotation onto the image layer, or inspect if the annotation is flattened.
creationDate Return the creation date of the annotation.
raw Return the raw data of the annotation.

Unknown Class

API Name Description
uid Return the uid of the annotation.
pageUid Return the uid of the page where the annotation is located.
creationDate Return the creation date of the annotation.
flattened Flattens the annotation onto the image layer, or inspect if the annotation is flattened.

This page is compatible for:

Is this page helpful?

YesYes NoNo

In this article: