Type Definitions
annotationProperties
Properties:
Name | Type | Description |
---|---|---|
lineColor |
string | A hex color value, absent the leading hash, for the line color of annotations. For instance, "00FF00". This will not be used for filled annotation types. |
lineWidth |
string | In pixels, the default line width for annotations without fill. |
fillCollor |
string | A hex color value, absent the leading hash, for the fill color of annotations. For instance, "00FF00". This will not be used for unfilled annotation types. |
stickyFillColor |
string | A hex color value, absent the leading hash, for the fill color of sticky note annotations specifically. For instance, "00FF00". |
stickyMargin |
number | The margin, in pixels, around the text in a sticky note annotation. |
highlightFillColor |
string | A hex color value, absent the leading hash, for the fill color of highlight annotations specifically. For instance, "00FF00". |
highlightOpacity |
number | A percentage, in decimal form, of the opacity of a highlight annotation. For instance, 0.5 for 50% opacity. |
redactionFillColor |
string | A hex color value, absent the leading hash, for the fill color of redactions specifically. For instance, "000000". |
redactionOpacity |
number | A percentage, in decimal form, of the opacity of an in-progress redaction annotation. For instance, 0.5 for 50% opacity. Burned redactions will be fully opaque, but this value can configure the transparency of a redaction that is not yet burned into the image. |
textString |
string | The default initial text for a text annotation or sticky note annotation. |
fontFace |
string | The font of the text in a text annotation or sticky note annotation. |
fontSize |
number | The size of the text in a text annotation or sticky note annotation. |
fontBold |
boolean | Whether the font in a text annotation or sticky note annotation is bolded. |
fontItalic |
boolean | Whether the font in a text annotation or sticky note annotation is italicized. |
fontColor |
string | A hex color value, absent the leading hash, for the font color of text in annotations. For instance, "00FF00". |
Hotkey
A VirtualViewer-specific hotkey.
Type:
- object
Properties:
Name | Type | Description |
---|---|---|
key |
string | Define one or more key patterns, separated by commas, as the hotkey. |
method |
function | The method triggered by the hotkey. |
localizedValue |
string | A reference to a locale json file, defining the displayed text of the hotkey hint. |
defaultValue |
string | A default hotkey hint. |
ImageInfoField
Type:
- object
Properties:
Name | Type | Description |
---|---|---|
fieldId |
string | The ID of the field. This should never be changed. |
fieldCaption |
string | The caption of the field displayed in the Image Info dialog. |
ImageStamp
Data used to load an image rubber stamp.
Type:
- object
Properties:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
stampTitle |
string | The displayed title of the image stamp. | ||
url |
string | The URI from which to load the stamp image. | ||
width |
number |
<optional> |
The internally-defined width of the image | The width of the image. |
height |
number |
<optional> |
The internally-defined height of the image | The height of the image. |
noteTemplate
A pre-written document note.
Type:
- object
Properties:
Name | Type | Description |
---|---|---|
noteTemplate.templateName |
string | The displayed name of the template. |
noteTemplate.templateString |
string | The contents of the document note. |