Skip to main content
Version: Version 5

Class: AnnotationRenderProperties

The AnnotationRenderProperties class encapsulates the rendering properties of a PDF annotation, providing a set of flags that control its rendering behaviors.

Constructors

Constructor

new AnnotationRenderProperties(): AnnotationRenderProperties

Returns

AnnotationRenderProperties

Accessors

fixedRotation

Get Signature

get fixedRotation(): boolean

Specifies whether the annotation’s appearance should remain fixed in orientation when the page is rotated.

Returns

boolean

Set Signature

set fixedRotation(fixedRotation): void

Parameters
fixedRotation

boolean

Returns

void


fixedZoom

Get Signature

get fixedZoom(): boolean

Indicates whether the annotation’s appearance should remain fixed in scale when the page’s magnification level is changed.

Returns

boolean

Set Signature

set fixedZoom(fixedZoom): void

Parameters
fixedZoom

boolean

Returns

void


renderToPrint

Get Signature

get renderToPrint(): boolean

Specifies whether the annotation should be printed when the page is printed, regardless of its visibility on the screen.

Returns

boolean

Set Signature

set renderToPrint(renderToPrint): void

Parameters
renderToPrint

boolean

Returns

void


renderToScreen

Get Signature

get renderToScreen(): boolean

If set to false, the annotation will not be displayed on the screen and interaction with the user will be disabled. The annotation may be printed (depending on the setting of the renderToPrint flag), but it should be considered hidden for purposes of onscreen display and user interaction.

Returns

boolean

Set Signature

set renderToScreen(renderToScreen): void

Parameters
renderToScreen

boolean

Returns

void