Class Annotations.HTMLAnnotation
Extends
Actions.Dispatcher, Annotations.Annotation.
Annotations.HTMLAnnotation
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
Annotations.HTMLAnnotation(options)
An common base class annotation that displays its contents using HTML5 instead of via Canvas.
|
| Field Attributes | Field Name and Description |
|---|---|
|
Gets the actions attached to this annotation as an object with triggers as keys and arrays of actions as values
|
|
|
Gets and sets the annotation's background color
|
|
|
Gets and sets the annotation's border (is a border, or a map of border properties)
|
|
|
Gets and sets the annotation's color (any type that can be used to construct Annotations.Color)
|
|
|
Gets the annotation's outer display element, if it exists
|
|
|
Gets and sets whether the annotation is hidden
|
|
|
Gets the annotation's inner UI element, if it exists
|
|
|
The annotation's rectangle
|
|
|
Gets and sets the annotation's rotation (must be one of 0, 90, 180, 270)
|
- Fields borrowed from class Annotations.Annotation:
- Author, Custom, DateModified, elementName, Height, Hidden, Id, IsAdded, IsDeleted, IsModified, Listable, NoMove, NoResize, NoRotate, NoZoom, PageNumber, Subject, Width, X, Y
- Methods borrowed from class Annotations.Annotation:
- adjustRect, deserialize, draw, getBottom, getContents, getCustom, getFlag, getHeight, getLeft, getPageNumber, getRect, getRectPadding, getReplies, getRight, getTop, getWidth, getX, getY, isReply, render, resize, serialize, setContents, setCustom, setFlag, setHeight, setPageNumber, setRect, setWidth, setX, setY, unrender
- Methods borrowed from class Actions.Dispatcher:
- addAction, addActions, addActionsFromXfdf, getActions, getDocumentViewer, saveActionsToXfdf, setDocumentViewer, triggerAction
Class Detail
Annotations.HTMLAnnotation(options)
An common base class annotation that displays its contents using HTML5 instead of via Canvas.
- Parameters:
- options
Field Detail
{{string|Actions.Action[]}}
actions
Gets the actions attached to this annotation as an object with triggers as keys and arrays of actions as values
- Default Value:
- {}
{Annotations.Color|object|array}
backgroundColor
Gets and sets the annotation's background color
- Default Value:
- new Annotations.Color()
{Annotations.Border|object}
border
Gets and sets the annotation's border (is a border, or a map of border properties)
- Default Value:
- new Annotations.Border()
{Annotations.Color|object|array}
color
Gets and sets the annotation's color (any type that can be used to construct Annotations.Color)
- Default Value:
- new Annotations.Color()
{($(Element)|null)}
element
Gets the annotation's outer display element, if it exists
{boolean}
hidden
Gets and sets whether the annotation is hidden
- Default Value:
- false
{($(Element)|null)}
innerElement
Gets the annotation's inner UI element, if it exists
{{x1: number|y1: number|x2: number|y2: number}}
rect
The annotation's rectangle
{number}
rotation
Gets and sets the annotation's rotation (must be one of 0, 90, 180, 270)
- Default Value:
- 0