Accusoft PDF Viewer Documentation

v3.11.158639

Interface FreehandDrawing

Freehand drawing annotation state.

Hierarchy

Index

Properties

Optional color

color: string

Color of the drawing path. Value must be a CSS-style, six-digit hex color string (like '#fa0404').

defaultvalue

'#000000'

drawingPath

drawingPath: string

Drawing path of the annotation. Value must be a subset of SVG path data syntax with the following restrictions:

  • Contains only M,C,L operators
  • Contains no spaces (must use commas instead)
  • Contains no negatives
  • Contains no omitted operators
  • Must have a length greater than 0

height

height: number

Height of the freehand drawing path's bounding 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 drawing path. 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.

Optional thickness

thickness: number

Thickness of the drawing path. Value must be from 1 to 50 inclusive.

defaultvalue

1

type

Indicates this annotation is a FreehandDrawing.

width

width: number

Width of the freehand drawing path's bounding 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 freehand drawing path's bounding rectangle in points (1/72 of an inch).

y

y: number

Distance from the top edge of the page to the top edge of the freehand drawing path's bounding rectangle in points (1/72 of an inch).

Legend

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