Interface AnnotOptions

Set alignment value.

Alignment

set border information.{all}[optional]

Border width.{all}[optional] The value range is between [0.01, 12], other values will not take effect

Border style.Style {0:"Solid", 1:"Dashed", 2:"UnderLine", 3:"Beveled",4:"Inset", 5:"Cloudy"}.{all}[optional]

Intensity of the cloudy effect.Only useful when parameter style is "Cloudy".{all}[optional] Valid value range: 0 to 2. 0 means no cloudy border effect. If the value is below 0, it will have the same effect as value 0. If the value is above 2, it will have the same effect as value 2.

Dash phase.Only useful when parameter style is "Dashed".{all}[optional]

A dash array that represents the dash patterns.Only useful when parameter style is "Dashed".{all}[optional]

style.Style {0:"Solid", 1:"Dashed", 2:"UnderLine", 3:"Beveled",4:"Inset", 5:"Cloudy"}.{all}[optional] If the boder style is set to the unsupporetd type annotation, It will change to set border style as 'Solid' by default internally. For details:

• 0 ("Solid"): Solid border.
• 1 ("Dashed"): This is only useful for link, free text, line, square, circle, polygon, polyline and screen annotation.
• 2 ("UnderLine"): This is only useful for link annotation.
• 3 ("Beveled"): Currently, It does not support the annotation appearance of this border style.
• 4 ("Inset"): Currently, It does not support the annotation appearance of this border style.
• 5 ("Cloudy"): This is only useful for free text, square, circle, and polygon annotations.

The buffer of file.{fileattachment,screen}

Only when the intent name of a free text annotation is "FreeTextCallout", this free text annotation can have callout line points property, and this property has effect on this kind of free text annotation's appearance. . {freetext && FreeTextCallout}[optional]

EndingStyle

Only when the intent name of a free text annotation is "FreeTextCallout", this free text annotation can have callout line points property, and this property has effect on this kind of free text annotation's appearance.{freetext}[optional]

New border color to be set.Format: 0xRRGGBB.{all}[optional]

Text string to be set as content for specified rich text. This should not be an empty string.

Set the content type (MIME type) of the media data. This is mandatory when the multiBuffer parameter exists.{screen}

New content string to be set.{all}[optional]

For a text markup annotation, quadrilaterals are required. This property has effect on text markup annotation's appearance. After setting new quadrilaterals, rectangle of current text markup annotation will be updated as well.In order to startCharIndex/endCharIndex priority.{textmarkup}(required)

Set creation date time.{markup}[optional]

Set last modified date time.{all}[optional]

Set annotation's default appearance.{freetext}[optional]

Set annotation's default text color (0x**RRGGBB).{freetext}[optional]

Set annotation's default text size.{freetext}[optional]

Set annotation's dictionary object.{all}[optional]

For a text markup annotation, index of the end character.{textmarkup}[optional]

Set the end point of line.{x: number, y: number}{line}[optional]

The value of the X-axis in the end point.{line}[optional]

The value of the Y-axis in the end point.{line}[optional]

Set line ending style of the end point. Please refer to {@link Ending_Style}.{line}[optional]

The file name to be set. This is mandatory when the multiBuffer parameter exists.{fileattachment,screen}

New fill color to be set. Format: 0xAARRGGBB, 0 for transparent, otherwise alpha will be set to 0xFF. {freetext,circle,square,polygon}[optional]

Set icon name.{stamp}[optional]

Set stamp icon's category.{stamp}[optional]

Specifies the icon of stamp. Attention: this property will override "icon" and "iconCategory" properties.{stamp}[optional]

The type of supported annot. Currently, it must be "stamp".{stamp}[optional]

Category which the icon is collected.{stamp}[optional]

The name of icon. Only ascii characters are available.{stamp}[optional]

The file type of icon. One of 'bmp', 'jpg', 'jpeg', 'png'.{stamp}[optional]

The url of icon. It supports HTTP, file, blob url and base64 url.{stamp}[optional]

Set ink list data.If type is "ink", it should not be an empty.{ink}

Set intent name.{markup}[optional] Some example intent: \li 'LineArrow' \li 'LineDimension' \li 'PolygonCloud' \li 'PolygonDimension' \li 'PolyLineDimension' \li 'FreeTextTypewriter' \li 'FreeTextCallout'

Set line's leader line length. {line}[optional]

Set the measure of line.{line}[optional]

Set the label for displaying the units for measuring.{line}[optional]

Set the scale ratio for measuring.{line}[optional]

Set the ratio value in user space.{line}[optional]

Set the ratio unit in user space.{line}[optional]

Set the ratio value in real space.{line}[optional]

Set the ratio unit in real space.{line}[optional]

The buffer of Media.{screen}

New unique ID string to be set.{all}[optional]

If true, no popup is generated,else popup is generated.{markup}[optional]

Set opacity value.only 0~1 is valid.{markup}[optional]

Rectangle of the new an notation.{all}

The x-coordinate of the input left-bottom corner.

The y-coordinate of the input left-bottom corner.

The x-coordinate of the input right-top corner.

The y-coordinate of the input right-top corner.

An array of rich text data. Now, Only support FreeText annotation.

rich text data object.

The style data of a rich text string

A valid font object.

the face name of the font.

The font styles. Please refer to @link Font_Styles @endlink .

The charset of the font. Please refer to @link Font_Charset @endlink or @link Font_CIDCharset @endlink .

Text size. It should not be negative value. 0 means text will not be shown.

Alignment value. Please Refer to @link Alignment @endlink .

Text color. Format: 0xRRGGBB.

A boolean value which indicates whether to make text bold or not.

A boolean value which indicates whether to italicize text or not.

A boolean value which indicates whether to underline text or not.

A boolean value which indicates whether to cross text out with strike through or not.

Corner mark style which can be used to make text as superscript or subscript or not as any kind of corner mark. 1 - Corner mark style: none. 2 - Corner mark style: superscript. 3 - Corner mark style: subscript.

Set the rotation in clockwise, Currently, only support free text, stamp, srceen annotations. for free text, srceen annotation, this should be one of these values : 0, 90, 180, 270. for stamp annotation, the value range is from 0 to 360.

For a text markup annotation,Index of the start character.{textmarkup}[optional]

Set the start point of line.{x: number, y: number}{line}[optional]

The value of the X-axis in the start point.{line}[optional]

The value of the Y-axis in the start point.{line}[optional]

Set line ending style of the start point. Please refer to {@link Ending_Style}.{line}[optional]

Set fill color for ending styles. New fill color to be set. Format: 0xRRGGBB, 0 for transparent, otherwise alpha will be set to 0xFF.{polyline,line}[optional]

Set subject string.If the value is "replace," that means that this is a Replace annotation.{markup}[optional]

Set title string.{markup}[optional]

The type of annotation to be added. Support type:

• highlight
  
• strikeOut
  
• underline
  
• squiggly
  
• caret
  
• fileAttachment
  
• freeText
  
• ink
  
• line
  
• link
  
• circle
  
• square
  
• polygon
  
• polyline
  
• stamp
  
• screen

Set vertexes, Vertexes property is required for a polyline annotation. {polyline,polygon}[optional]