Accusoft PDF Viewer Documentation

v3.11.158639

Interface Rectangle

Rectangle annotation state.

Hierarchy

Index

Properties

Optional borderColor

borderColor: string

Border color. Value must be a CSS-style, six-digit hex color string (like '#fa0404') or the special value 'transparent' to prevent drawing a border.

defaultvalue

'#000000'

Optional borderThickness

borderThickness: number

Border thickness in points. Value must be an integer from 1 to 50 inclusive.

defaultvalue

1

Optional fillColor

fillColor: string

Fill color. Value must be a CSS-style, six-digit hex color string (like '#fa0404') or the special value 'transparent' to prevent filling the rectangle.

defaultvalue

'#000000'

height

height: number

Height of the rectangle in points (1/72 of an inch). Value must be greater than or equal to 0.0.

Optional id

id: string

Unique identifier for the annotation.

defaultvalue

undefined

Optional opacity

opacity: number

Opacity of the entire rectangle, both the fill and the border. Value must be an integer from 0 to 255 inclusive. 0 is transparent and 255 is fully opaque.

defaultvalue

255

pageNumber

pageNumber: number

One-indexed page number where the annotation is placed. Must be an integer greater than zero.

type

type: Rectangle

Indicates this annotation is a Rectangle.

width

width: number

Width of the rectangle in points (1/72 of an inch). Value must be greater than or equal to 0.0.

x

x: number

Distance from the left edge of the page to the left edge of the rectangle in points (1/72 of an inch).

y

y: number

Distance from the top of the page to the top edge of the rectangle in points (1/72 of an inch).

Legend

  • Property
  • Method
  • Static method
© 2022 Accusoft Corporation. All rights reserved.