PdfPolygonAnnotation | Syncfusion TypeScript

PdfPolygonAnnotation class represents the polygon annotation objects.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Create a new polygon annotation with bounds
const annotation: PdfPolygonAnnotation = new PdfPolygonAnnotation([100, 300, 150, 200, 300, 200, 350, 300, 300, 400, 150, 400]);
// Add annotation to the page
page.annotations.add(annotation);
// Destroy the document
document.destroy();

Hierarchy

PdfComment
- PdfPolygonAnnotation

Index

Constructors

constructor

Accessors

Methods

Constructors

Private constructor

new PdfPolygonAnnotation(): PdfPolygonAnnotation
new PdfPolygonAnnotation(points: number[]): PdfPolygonAnnotation

- Defined in pdf/core/annotations/annotation.ts:5419
Initializes a new instance of the PdfPolygonAnnotation class.

Returns PdfPolygonAnnotation

Initializes a new instance of the PdfPolygonAnnotation class.

Parameters

points: number[]

Line points.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Create a new polygon annotation with bounds
const annotation: PdfPolygonAnnotation = new PdfPolygonAnnotation([100, 300, 150, 200, 300, 200, 350, 300, 300, 400, 150, 400]);
// Add annotation to the page
page.annotations.add(annotation);
// Destroy the document
document.destroy();

Returns PdfPolygonAnnotation

Properties

_annotFlags

_annotFlags: PdfAnnotationFlag

_appearanceTemplate

_appearanceTemplate: PdfTemplate

_authorBoldFont

_authorBoldFont: PdfStandardFont = new PdfStandardFont(PdfFontFamily.helvetica, 10.5, PdfFontStyle.bold)

_borderEffect

_borderEffect: PdfBorderEffect

_bounds

_bounds: { height: number; width: number; x: number; y: number }

Type declaration

height: number
width: number
x: number
y: number

_circleCaptionFont

_circleCaptionFont: PdfStandardFont = new PdfStandardFont(PdfFontFamily.helvetica, 8, PdfFontStyle.regular)

_color

_color: number[]

_flatten

_flatten: boolean = false

_innerColor

_innerColor: number[]

Private _intensity

_intensity: number

_isAllRotation

_isAllRotation: boolean = true

_isBounds

_isBounds: boolean

_isChanged

_isChanged: boolean = false

_isExport

_isExport: boolean = false

_isFlattenPopups

_isFlattenPopups: boolean

_isImported

_isImported: boolean = false

_isLoaded

_isLoaded: boolean = false

_isRotated

_isRotated: boolean = false

_isTransparentColor

_isTransparentColor: boolean = false

_isWidget

_isWidget: boolean

_lineCaptionFont

_lineCaptionFont: PdfStandardFont = new PdfStandardFont(PdfFontFamily.helvetica, 10, PdfFontStyle.regular)

Private _lineExtension

_lineExtension: number

_locationDisplaced

_locationDisplaced: boolean

_opacity

_opacity: number = 1

_page

_page: PdfPage

_pdfFont

_pdfFont: PdfFont

Private _points

_points: number[]

_popUpFont

_popUpFont: PdfStandardFont = new PdfStandardFont(PdfFontFamily.helvetica, 10.5)

_ref

_ref: _PdfReference

_reviewHistory

_reviewHistory: PdfPopupAnnotationCollection

_rotate

_rotate: PdfRotationAngle

_setAppearance

_setAppearance: boolean = false

_text

_text: string

_type

_type: _PdfAnnotationType

_value

_value: string

Accessors

_degreeToRadian

get _degreeToRadian(): number

Inherited from PdfAnnotation._degreeToRadian
- Defined in pdf/core/annotations/annotation.ts:1039
Returns number

_hasFlags

get _hasFlags(): boolean

Inherited from PdfAnnotation._hasFlags
- Defined in pdf/core/annotations/annotation.ts:1036
Returns boolean

author

get author(): string
set author(value: string): void

Gets the author of the annotation.

Returns string

Author.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
//Get the author of the annotation.
let author: string = annotation.author;
// Destroy the document
document.destroy();

Sets the author of the annotation.

Parameters

value: string

Author.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
// Sets the author of the annotation.
annotation.author = ‘Syncfusion’;
// Destroy the document
document.destroy();

Returns void

Author.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
//Get the author of the annotation.
let author: string = annotation.author;
// Destroy the document
document.destroy();

border

get border(): PdfAnnotationBorder
set border(value: PdfAnnotationBorder): void

Gets the border of the annotation.

Returns PdfAnnotationBorder

Annotation border.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
// Gets the border of the annotation.
let border: PdfAnnotationBorder = annotation.border;
// Destroy the document
document.destroy();

Sets the border of the annotation.

Parameters

value: PdfAnnotationBorder

Border.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
// Initializes a new instance of the ` PdfAnnotationBorder ` class.
let border: PdfAnnotationBorder = new PdfAnnotationBorder ();
//Sets the width of the annotation border.
border.width = 10;
//Sets the style of the annotation border.
border.style = PdfBorderStyle.dashed;
//Sets the dash pattern of the annotation border.
border.dash = [1, 2, 1];
// Sets the border to the PDF annotation
annotation.border = border;
// Destroy the document
document.destroy();

Returns void

Annotation border.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
// Gets the border of the annotation.
let border: PdfAnnotationBorder = annotation.border;
// Destroy the document
document.destroy();

borderEffect

get borderEffect(): PdfBorderEffect
set borderEffect(value: PdfBorderEffect): void

Gets the border effect of the polygon annotation.

Returns PdfBorderEffect

Border effect.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfPolygonAnnotation = page.annotations.at(0) as PdfPolygonAnnotation;
// Gets the border effect of the polygon annotation.
let borderEffect: PdfBorderEffect = annotation.borderEffect;
// Destroy the document
document.destroy();

Sets the border effect of the polygon annotation.

Parameters

value: PdfBorderEffect

Border effect.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfPolygonAnnotation = page.annotations.at(0) as PdfPolygonAnnotation;
// Sets the border effect of the polygon annotation
annotation.borderEffect.style = PdfBorderEffectStyle.cloudy ;
// Save the document
document.save('output.pdf');
// Destroy the document
document.destroy();

Returns void

Border effect.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfPolygonAnnotation = page.annotations.at(0) as PdfPolygonAnnotation;
// Gets the border effect of the polygon annotation.
let borderEffect: PdfBorderEffect = annotation.borderEffect;
// Destroy the document
document.destroy();

bounds

get bounds(): { height: number; width: number; x: number; y: number }
set bounds(value: { height: number; width: number; x: number; y: number }): void

Gets the bounds of the annotation.

Returns { height: number; width: number; x: number; y: number }

Bounds.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
// Gets the bounds of the annotation.
let bounds: {x: number, y: number, width: number, height: number} = annotation.bounds;
// Destroy the document
document.destroy();

height: number
width: number
x: number
y: number

Sets the bounds of the annotation.

Parameters

value: { height: number; width: number; x: number; y: number }

bounds.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
// Sets the bounds of the annotation.
annotation.bounds = {x: 10, y: 10, width: 150, height: 5};
// Destroy the document
document.destroy();

height: number
width: number
x: number
y: number

Returns void

Bounds.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
// Gets the bounds of the annotation.
let bounds: {x: number, y: number, width: number, height: number} = annotation.bounds;
// Destroy the document
document.destroy();

caption

get caption(): PdfAnnotationCaption
set caption(value: PdfAnnotationCaption): void

Gets the caption of the annotation.

Returns PdfAnnotationCaption

Annotation caption.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
// Gets the caption of the annotation.
let caption: PdfAnnotationCaption = annotation.caption;
// Destroy the document
document.destroy();

Sets the caption of the annotation.

Parameters

value: PdfAnnotationCaption

Annottion caption.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
// Create and set annotation caption values
annotation.caption = new PdfAnnotationCaption(true, PdfLineCaptionType.inline, [10, 10]);
// Destroy the document
document.destroy();

Returns void

Annotation caption.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
// Gets the caption of the annotation.
let caption: PdfAnnotationCaption = annotation.caption;
// Destroy the document
document.destroy();

color

get color(): number[]
set color(value: number[]): void

Gets the fore color of the annotation.

Returns number[]

R, G, B color values in between 0 to 255.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
// Gets the color of the annotation.
let color: number[] = annotation.color;
// Destroy the document
document.destroy();

Sets the fore color of the annotation.

Parameters

value: number[]

R, G, B color values in between 0 to 255.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
// Sets the color of the annotation.
annotation.color = [255, 0, 0];
// Destroy the document
document.destroy();

Returns void

R, G, B color values in between 0 to 255.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
// Gets the color of the annotation.
let color: number[] = annotation.color;
// Destroy the document
document.destroy();

comments

get comments(): PdfPopupAnnotationCollection

Gets the comments of the PDF annotation (Read only).

Returns PdfPopupAnnotationCollection

Annotation comments

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data);
// Access first page
let page: PdfPage = document.getPage(0);
// Access the annotation at index 0
let annotation: PdfRectangleAnnotation = page.annotations.at(0) as PdfRectangleAnnotation;
// Gets the comments of the PDF annotation
let comments: PdfPopupAnnotationCollection = annotation.comments;
// Save the document
document.save('output.pdf');
// Destroy the document
document.destroy();

creationDate

get creationDate(): Date
set creationDate(value: Date): void

Gets the creation date of the annotation.

Returns Date

Creation date.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
//Get the creation date of the annotation.
let creationDate: Date = annotation.creationDate;
// Destroy the document
document.destroy();

Sets the creation date of the annotation.

Parameters

value: Date

Creation date.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
//Set the creation date of the annotation.
annotation.creationDate = new Date();
// Destroy the document
document.destroy();

Returns void

Creation date.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
//Get the creation date of the annotation.
let creationDate: Date = annotation.creationDate;
// Destroy the document
document.destroy();

flags

get flags(): PdfAnnotationFlag
set flags(value: PdfAnnotationFlag): void

Gets the flags of the annotation.

Returns PdfAnnotationFlag

Annotation flag.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
// Gets the flags of the annotation.
let flag: PdfAnnotationFlag = annotation.flags;
// Destroy the document
document.destroy();

Sets the flags of the annotation.

Parameters

value: PdfAnnotationFlag

flag value.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
// Sets the flags of the annotation.
annotation.flags = PdfAnnotationFlag.print;
// Destroy the document
document.destroy();

Returns void

Annotation flag.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
// Gets the flags of the annotation.
let flag: PdfAnnotationFlag = annotation.flags;
// Destroy the document
document.destroy();

flatten

get flatten(): boolean
set flatten(value: boolean): void

Gets the boolean flag indicating whether the annotation have been flattened or not.

Returns boolean

Flatten.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
// Gets the boolean flag indicating whether the annotation have been flattened or not.
let flatten: boolean = annotation.flatten;
// Destroy the document
document.destroy();

Sets the boolean flag indicating whether the annotation have been flattened or not.

Parameters

value: boolean

Flatten.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
// Sets the boolean flag indicating whether the annotation have been flattened or not.
annotation.flatten = true;
// Destroy the document
document.destroy();

Returns void

Flatten.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
// Gets the boolean flag indicating whether the annotation have been flattened or not.
let flatten: boolean = annotation.flatten;
// Destroy the document
document.destroy();

flattenPopups

get flattenPopups(): boolean
set flattenPopups(value: boolean): void

Gets the boolean flag indicating whether annotation's popup have been flattened or not.

Returns boolean

Flatten Popup.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
// Gets the boolean flag indicating whether annotation's popup have been flattened or not.
let flattenPopups: boolean = annotation.flattenPopups;
// Destroy the document
document.destroy();

Sets the boolean flag indicating whether the annotation’s popup have been flattened or not.

Parameters

value: boolean

Flatten Popup.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
// Sets the boolean flag indicating whether the annotation’s popup have been flattened or not.
annotation.flattenPopups = false;
// Destroy the document
document.destroy();

Returns void

Flatten Popup.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
// Gets the boolean flag indicating whether annotation's popup have been flattened or not.
let flattenPopups: boolean = annotation.flattenPopups;
// Destroy the document
document.destroy();

innerColor

get innerColor(): number[]
set innerColor(value: number[]): void

Gets the inner color of the annotation.

Returns number[]

R, G, B color values in between 0 to 255.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
// Gets the inner color of the annotation.
let innerColor: number[] = annotation.innerColor;
// Destroy the document
document.destroy();

Sets the inner color of the annotation.

Parameters

value: number[]

R, G, B color values in between 0 to 255.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
// Sets the inner color of the annotation.
annotation.innerColor = [255, 0, 0];
// Destroy the document
document.destroy();

Returns void

R, G, B color values in between 0 to 255.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
// Gets the inner color of the annotation.
let innerColor: number[] = annotation.innerColor;
// Destroy the document
document.destroy();

layer

get layer(): PdfLayer
set layer(value: PdfLayer): void

Gets the PdfLayer of the annotation.

Returns PdfLayer

PDF layer to the annotation.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data);
// Get the first page of the document
let page: PdfPage = document.getPage(0);
// Access the first annotation on the page
let annotation: PdfAnnotation = page.annotations.at(0);
// Get the layer of the annotation
let layer: PdfLayer = annotation.layer;
// Save the document
document.save('output.pdf');
// Destroy the document
document.destroy();

Set the PdfLayer to the annotation.

Parameters

value: PdfLayer

PDF layer to the annotation.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data);
// Get the first page of the document
let page: PdfPage = document.getPage(0);
// Access the collection of layers in the document
let layers: PdfLayerCollection = document.layers;
// Add a new layer to the document with the name 'Layer1'
let layer: PdfLayer = layers.add('Layer1');
// Access the first annotation on the page
let annotation: PdfAnnotation = page.annotations.at(0);
// Assign the layer to the annotation
annotation.layer = layer;
// Save the document
document.save('output.pdf');
// Destroy the document
document.destroy();

Returns void

PDF layer to the annotation.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data);
// Get the first page of the document
let page: PdfPage = document.getPage(0);
// Access the first annotation on the page
let annotation: PdfAnnotation = page.annotations.at(0);
// Get the layer of the annotation
let layer: PdfLayer = annotation.layer;
// Save the document
document.save('output.pdf');
// Destroy the document
document.destroy();

lineExtension

get lineExtension(): number
set lineExtension(value: number): void

Gets the line extension of the polygon annotation.

Returns number

Line extension.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfPolygonAnnotation = page.annotations.at(0) as PdfPolygonAnnotation;
// Gets the line extension of the polygon annotation
let lineExtension: number = annotation.lineExtension;
// Destroy the document
document.destroy();

Sets the line extension of the polygon annotation.

Parameters

value: number

Line extension.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfPolygonAnnotation = page.annotations.at(0) as PdfPolygonAnnotation;
// Sets the line extension of the polygon annotation
annotation.lineExtension = 5;
// Save the document
document.save('output.pdf');
// Destroy the document
document.destroy();

Returns void

Line extension.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfPolygonAnnotation = page.annotations.at(0) as PdfPolygonAnnotation;
// Gets the line extension of the polygon annotation
let lineExtension: number = annotation.lineExtension;
// Destroy the document
document.destroy();

modifiedDate

get modifiedDate(): Date
set modifiedDate(value: Date): void

Gets the modification date of the annotation.

Returns Date

Modified date.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
//Get the modified date of the annotation.
let modifiedDate: Date = annotation.modifiedDate;
// Destroy the document
document.destroy();

Sets the modification date of the annotation.

Parameters

value: Date

Modified date.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
//Set the modified date of the annotation.
annotation.modifiedDate = new Date();
// Destroy the document
document.destroy();

Returns void

Modified date.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
//Get the modified date of the annotation.
let modifiedDate: Date = annotation.modifiedDate;
// Destroy the document
document.destroy();

name

get name(): string
set name(value: string): void

Gets the name of the annotation.

Returns string

Name.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
//Get the name of the annotation.
let name: string = annotation.name;
// Destroy the document
document.destroy();

Sets the name of the annotation.

Parameters

value: string

Name.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
// Sets the name of the annotation.
annotation.name = 'LineAnnotation';
// Destroy the document
document.destroy();

Returns void

Name.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
//Get the name of the annotation.
let name: string = annotation.name;
// Destroy the document
document.destroy();

opacity

get opacity(): number
set opacity(value: number): void

Gets the opacity of the annotation.

Returns number

Opacity in between 0 t0 1.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
//Get the opacity of the annotation.
let opacity: number = annotation.opacity;
// Destroy the document
document.destroy();

Sets the opacity of the annotation.

Parameters

value: number

opacity in between 0 t0 1.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
// Sets the opacity of the annotation.
annotation.opacity = 0.5;
// Destroy the document
document.destroy();

Returns void

Opacity in between 0 t0 1.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
//Get the opacity of the annotation.
let opacity: number = annotation.opacity;
// Destroy the document
document.destroy();

reviewHistory

get reviewHistory(): PdfPopupAnnotationCollection

Gets the review history of the PDF annotation (Read only).

Returns PdfPopupAnnotationCollection

Annotation review history.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data);
// Access first page
let page: PdfPage = document.getPage(0);
// Access the annotation at index 0
let annotation: PdfRectangleAnnotation = page.annotations.at(0) as PdfRectangleAnnotation;
// Gets the comments of the PDF annotation
let comments: PdfPopupAnnotationCollection = annotation.reviewHistory;
// Save the document
document.save('output.pdf');
// Destroy the document
document.destroy();

rotate

get rotate(): number

Gets the rotation angle of the annotation (Read only).

Returns number

Rotation angle.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
//Get the rotation angle of the annotation.
let rotate: number = annotation.rotate;
// Destroy the document
document.destroy();

rotationAngle

get rotationAngle(): PdfRotationAngle
set rotationAngle(value: PdfRotationAngle): void

Gets the rotation of the annotation.

Returns PdfRotationAngle

Rotation angle.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
//Get the rotation angle of the annotation.
let rotationAngle: PdfRotationAngle = annotation.rotationAngle;
// Destroy the document
document.destroy();

Sets the rotation of the annotation.

Parameters

value: PdfRotationAngle

rotation angle.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
// Sets the rotation angle of the annotation.
annotation.rotationAngle = PdfRotationAngle.angle180;
// Destroy the document
document.destroy();

Returns void

Rotation angle.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
//Get the rotation angle of the annotation.
let rotationAngle: PdfRotationAngle = annotation.rotationAngle;
// Destroy the document
document.destroy();

subject

get subject(): string
set subject(value: string): void

Gets the subject of the annotation.

Returns string

Subject.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
//Get the subject of the annotation.
let subject: string = annotation.subject;
// Destroy the document
document.destroy();

Sets the subject of the annotation.

Parameters

value: string

Subject.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
// Sets the subject of the annotation.
annotation.subject = 'Line Annotation';
// Destroy the document
document.destroy();

Returns void

Subject.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
//Get the subject of the annotation.
let subject: string = annotation.subject;
// Destroy the document
document.destroy();

text

get text(): string
set text(value: string): void

Gets the text of the annotation.

Returns string

Text.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
//Get the text of the annotation.
let text: string = annotation.text;
// Destroy the document
document.destroy();

Sets the text of the annotation.

Parameters

value: string

Text.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
// Sets the text of the annotation.
annotation.text = ‘LineAnnotation’;
// Destroy the document
document.destroy();

Returns void

Text.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
//Get the text of the annotation.
let text: string = annotation.text;
// Destroy the document
document.destroy();

Methods

_calculateTemplateBounds

_calculateTemplateBounds(bounds: { height: number; width: number; x: number; y: number }, page: PdfPage, template: PdfTemplate, isNormalMatrix: boolean, graphics: PdfGraphics): { height: number; width: number; x: number; y: number }

Inherited from PdfAnnotation._calculateTemplateBounds
- Defined in pdf/core/annotations/annotation.ts:1497
Parameters
- bounds: { height: number; width: number; x: number; y: number }
  - height: number
  - width: number
  - x: number
  - y: number
- page: PdfPage
- template: PdfTemplate
- isNormalMatrix: boolean
- graphics: PdfGraphics
Returns { height: number; width: number; x: number; y: number }
- height: number
- width: number
- x: number
- y: number

_colorToHex

_colorToHex(col: number[]): string

Inherited from PdfAnnotation._colorToHex
- Defined in pdf/core/annotations/annotation.ts:2434
Parameters
- col: number[]
Returns string

_componentToHex

_componentToHex(c: number): string

Inherited from PdfAnnotation._componentToHex
- Defined in pdf/core/annotations/annotation.ts:2441
Parameters
- c: number
Returns string

_createBezier

_createBezier(first: number[], second: number[], third: number[], bezierPoints: Array<number[]>): void

Inherited from PdfAnnotation._createBezier
- Defined in pdf/core/annotations/annotation.ts:1992
Parameters
- first: number[]
- second: number[]
- third: number[]
- bezierPoints: Array<number[]>
Returns void

_createCircleAppearance

_createCircleAppearance(): PdfTemplate

Inherited from PdfAnnotation._createCircleAppearance
- Defined in pdf/core/annotations/annotation.ts:1891
Returns PdfTemplate

_createMeasureDictionary

_createMeasureDictionary(unitString: string): _PdfDictionary

Inherited from PdfAnnotation._createMeasureDictionary
- Defined in pdf/core/annotations/annotation.ts:2391
Parameters
- unitString: string
Returns _PdfDictionary

_createPolygonAppearance

_createPolygonAppearance(flatten: boolean): PdfTemplate

- Defined in pdf/core/annotations/annotation.ts:5698
Parameters
- flatten: boolean
Returns PdfTemplate

_createRectangleAppearance

_createRectangleAppearance(borderEffect: PdfBorderEffect): PdfTemplate

Inherited from PdfAnnotation._createRectangleAppearance
- Defined in pdf/core/annotations/annotation.ts:1807
Parameters
- borderEffect: PdfBorderEffect
Returns PdfTemplate

_dateToString

_dateToString(dateTime: Date): string

Inherited from PdfAnnotation._dateToString
- Defined in pdf/core/annotations/annotation.ts:2750
Parameters
- dateTime: Date
Returns string

_doPostProcess

_doPostProcess(isFlatten?: boolean): void

Overrides PdfAnnotation._doPostProcess
- Defined in pdf/core/annotations/annotation.ts:5626
Parameters
- Default value isFlatten: boolean = false
Returns void

_drawAuthor

_drawAuthor(author: string, subject: string, bounds: number[], backBrush: PdfBrush, aBrush: PdfBrush, _page: PdfPage, trackingHeight: number, border: PdfAnnotationBorder): number

Inherited from PdfAnnotation._drawAuthor
- Defined in pdf/core/annotations/annotation.ts:2655
Parameters
- author: string
- subject: string
- bounds: number[]
- backBrush: PdfBrush
- aBrush: PdfBrush
- _page: PdfPage
- trackingHeight: number
- border: PdfAnnotationBorder
Returns number

_drawCircleAppearance

_drawCircleAppearance(rectangle: number[], borderWidth: number, graphics: PdfGraphics, parameter: _PaintParameter): void

Inherited from PdfAnnotation._drawCircleAppearance
- Defined in pdf/core/annotations/annotation.ts:1943
Parameters
- rectangle: number[]
- borderWidth: number
- graphics: PdfGraphics
- parameter: _PaintParameter
Returns void

_drawCloudStyle

_drawCloudStyle(graphics: PdfGraphics, brush: PdfBrush, pen: PdfPen, radius: number, overlap: number, points: Array<number[]>, isAppearance: boolean): void

Inherited from PdfAnnotation._drawCloudStyle
- Defined in pdf/core/annotations/annotation.ts:1604
Parameters
- graphics: PdfGraphics
- brush: PdfBrush
- pen: PdfPen
- radius: number
- overlap: number
- points: Array<number[]>
- isAppearance: boolean
Returns void

_drawLineEndStyle

_drawLineEndStyle(axisPoint: number[], graphics: PdfGraphics, angle: number, pen: PdfPen, brush: PdfBrush, style: PdfLineEndingStyle, length: number, isBegin: boolean): void

Inherited from PdfAnnotation._drawLineEndStyle
- Defined in pdf/core/annotations/annotation.ts:2167
Parameters
- axisPoint: number[]
- graphics: PdfGraphics
- angle: number
- pen: PdfPen
- brush: PdfBrush
- style: PdfLineEndingStyle
- length: number
- isBegin: boolean
Returns void

_drawLineStyle

_drawLineStyle(start: number[], end: number[], graphics: PdfGraphics, angle: number, pen: PdfPen, brush: PdfBrush, lineStyle: PdfAnnotationLineEndingStyle, length: number): void

Inherited from PdfAnnotation._drawLineStyle
- Defined in pdf/core/annotations/annotation.ts:2256
Parameters
- start: number[]
- end: number[]
- graphics: PdfGraphics
- angle: number
- pen: PdfPen
- brush: PdfBrush
- lineStyle: PdfAnnotationLineEndingStyle
- length: number
Returns void

_drawRectangleAppearance

_drawRectangleAppearance(rectangle: number[], graphics: PdfGraphics, parameter: _PaintParameter, intensity: number): void

Inherited from PdfAnnotation._drawRectangleAppearance
- Defined in pdf/core/annotations/annotation.ts:1873
Parameters
- rectangle: number[]
- graphics: PdfGraphics
- parameter: _PaintParameter
- intensity: number
Returns void

_drawSubject

_drawSubject(subject: string, contentRect: number[], _page: PdfPage): void

Inherited from PdfAnnotation._drawSubject
- Defined in pdf/core/annotations/annotation.ts:2699
Parameters
- subject: string
- contentRect: number[]
- _page: PdfPage
Returns void

_flattenAnnotationTemplate

_flattenAnnotationTemplate(template: PdfTemplate, isNormalMatrix: boolean, isLineAnnotation?: boolean): void

Inherited from PdfAnnotation._flattenAnnotationTemplate
- Defined in pdf/core/annotations/annotation.ts:1338
Parameters
- template: PdfTemplate
- isNormalMatrix: boolean
- Default value isLineAnnotation: boolean = false
Returns void

_flattenLoadedPopUp

_flattenLoadedPopUp(): void

Inherited from PdfAnnotation._flattenLoadedPopUp
- Defined in pdf/core/annotations/annotation.ts:2562
Returns void

_flattenPop

_flattenPop(_page: PdfPage, color: number[], boundsValue: { height: number; width: number; x: number; y: number }, border: PdfAnnotationBorder, author: string, subject: string, text: string): void

Inherited from PdfAnnotation._flattenPop
- Defined in pdf/core/annotations/annotation.ts:2484
Parameters
- _page: PdfPage
- color: number[]
- boundsValue: { height: number; width: number; x: number; y: number }
  - height: number
  - width: number
  - x: number
  - y: number
- border: PdfAnnotationBorder
- author: string
- subject: string
- text: string
Returns void

_flattenPopUp

_flattenPopUp(): void

Inherited from PdfAnnotation._flattenPopUp
- Defined in pdf/core/annotations/annotation.ts:2481
Returns void

_getAngle

_getAngle(linePoints: number[]): number

Inherited from PdfAnnotation._getAngle
- Defined in pdf/core/annotations/annotation.ts:2015
Parameters
- linePoints: number[]
Returns number

_getAxisValue

_getAxisValue(value: number[], angle: number, length?: number): number[]

Inherited from PdfAnnotation._getAxisValue
- Defined in pdf/core/annotations/annotation.ts:2039
Parameters
- value: number[]
- angle: number
- Optional length: number
Returns number[]

_getBorderColorString

_getBorderColorString(color: number[]): string

Inherited from PdfAnnotation._getBorderColorString
- Defined in pdf/core/annotations/annotation.ts:2707
Parameters
- color: number[]
Returns string

_getBoundsFromLineEndStyle

_getBoundsFromLineEndStyle(axisPoint: number[], angle: number, pen: PdfPen, style: PdfLineEndingStyle, length: number, isBegin: boolean): { height: number; width: number; x: number; y: number }

Inherited from PdfAnnotation._getBoundsFromLineEndStyle
- Defined in pdf/core/annotations/annotation.ts:2102
Parameters
- axisPoint: number[]
- angle: number
- pen: PdfPen
- style: PdfLineEndingStyle
- length: number
- isBegin: boolean
Returns { height: number; width: number; x: number; y: number }
- height: number
- width: number
- x: number
- y: number

_getBoundsValue

_getBoundsValue(linePoints: number[], borderWidth?: number): { height: number; width: number; x: number; y: number }

Inherited from PdfAnnotation._getBoundsValue
- Defined in pdf/core/annotations/annotation.ts:1231
Parameters
- linePoints: number[]
- Optional borderWidth: number
Returns { height: number; width: number; x: number; y: number }
- height: number
- width: number
- x: number
- y: number

_getCombinedRectangleBounds

_getCombinedRectangleBounds(rect1: { height: number; width: number; x: number; y: number }, rect2: { height: number; width: number; x: number; y: number }): { height: number; width: number; x: number; y: number }

Inherited from PdfAnnotation._getCombinedRectangleBounds
- Defined in pdf/core/annotations/annotation.ts:2242
Parameters
- rect1: { height: number; width: number; x: number; y: number }
  - height: number
  - width: number
  - x: number
  - y: number
- rect2: { height: number; width: number; x: number; y: number }
  - height: number
  - width: number
  - x: number
  - y: number
Returns { height: number; width: number; x: number; y: number }
- height: number
- width: number
- x: number
- y: number

_getCropOrMediaBox

_getCropOrMediaBox(): number[]

Inherited from PdfAnnotation._getCropOrMediaBox
- Defined in pdf/core/annotations/annotation.ts:2806
Returns number[]

_getEqualPdfGraphicsUnit

_getEqualPdfGraphicsUnit(measurementUnit: PdfMeasurementUnit, unitString: string): { graphicsUnit: _PdfGraphicsUnit; unitString: string }

Inherited from PdfAnnotation._getEqualPdfGraphicsUnit
- Defined in pdf/core/annotations/annotation.ts:2360
Parameters
- measurementUnit: PdfMeasurementUnit
- unitString: string
Returns { graphicsUnit: _PdfGraphicsUnit; unitString: string }
- graphicsUnit: _PdfGraphicsUnit
- unitString: string

_getForeColor

_getForeColor(color: number[]): number[]

Inherited from PdfAnnotation._getForeColor
- Defined in pdf/core/annotations/annotation.ts:2651
Parameters
- color: number[]
Returns number[]

_getIntersectionDegrees

_getIntersectionDegrees(first: number[], second: number[], radius: number): number[]

Inherited from PdfAnnotation._getIntersectionDegrees
- Defined in pdf/core/annotations/annotation.ts:1733
Parameters
- first: number[]
- second: number[]
- radius: number
Returns number[]

_getLinePoints

_getLinePoints(): Array<number[]>

- Defined in pdf/core/annotations/annotation.ts:5794
Returns Array<number[]>

_getMediaOrCropBox

_getMediaOrCropBox(page: PdfPage): number[]

Inherited from PdfAnnotation._getMediaOrCropBox
- Defined in pdf/core/annotations/annotation.ts:1222
Parameters
- page: PdfPage
Returns number[]

_getPoints

_getPoints(polygonPoints: number[]): number[]

Inherited from PdfAnnotation._getPoints
- Defined in pdf/core/annotations/annotation.ts:2786
Parameters
- polygonPoints: number[]
Returns number[]

_getRectangleBoundsValue

_getRectangleBoundsValue(): number[]

Inherited from PdfAnnotation._getRectangleBoundsValue
- Defined in pdf/core/annotations/annotation.ts:2627
Returns number[]

_getRotatedBounds

_getRotatedBounds(bounds: { height: number; width: number; x: number; y: number }, rotateAngle: number): { height: number; width: number; x: number; y: number }

Inherited from PdfAnnotation._getRotatedBounds
- Defined in pdf/core/annotations/annotation.ts:2445
Parameters
- bounds: { height: number; width: number; x: number; y: number }
  - height: number
  - width: number
  - x: number
  - y: number
- rotateAngle: number
Returns { height: number; width: number; x: number; y: number }
- height: number
- width: number
- x: number
- y: number

_getRotationAngle

_getRotationAngle(): number

Inherited from PdfAnnotation._getRotationAngle
- Defined in pdf/core/annotations/annotation.ts:1210
Returns number

_initialize

_initialize(page: PdfPage, dictionary?: _PdfDictionary): void

Overrides PdfAnnotation._initialize
- Defined in pdf/core/annotations/annotation.ts:5572
Parameters
- page: PdfPage
- Optional dictionary: _PdfDictionary
Returns void

_isClockWise

_isClockWise(points: Array<number[]>): boolean

Inherited from PdfAnnotation._isClockWise
- Defined in pdf/core/annotations/annotation.ts:1722
Parameters
- points: Array<number[]>
Returns boolean

_midPoint

_midPoint(first: number[], second: number[]): number[]

Inherited from PdfAnnotation._midPoint
- Defined in pdf/core/annotations/annotation.ts:2012
Parameters
- first: number[]
- second: number[]
Returns number[]

_obtainFont

_obtainFont(): PdfFont

Inherited from PdfAnnotation._obtainFont
- Defined in pdf/core/annotations/annotation.ts:2356
Returns PdfFont

_obtainFontDetails

_obtainFontDetails(): { name: string; size: number; style: PdfFontStyle }

Inherited from PdfAnnotation._obtainFontDetails
- Defined in pdf/core/annotations/annotation.ts:2271
Returns { name: string; size: number; style: PdfFontStyle }
- name: string
- size: number
- style: PdfFontStyle

_obtainGraphicsRotation

_obtainGraphicsRotation(matrix: _PdfTransformationMatrix): number

Inherited from PdfAnnotation._obtainGraphicsRotation
- Defined in pdf/core/annotations/annotation.ts:1582
Parameters
- matrix: _PdfTransformationMatrix
Returns number

_obtainNativeRectangle

_obtainNativeRectangle(): number[]

Inherited from PdfAnnotation._obtainNativeRectangle
- Defined in pdf/core/annotations/annotation.ts:2773
Returns number[]

_obtainStyle

_obtainStyle(borderPen: PdfPen, rectangle: number[], borderWidth: number, parameter?: PdfBorderEffect | _PaintParameter): number[]

Inherited from PdfAnnotation._obtainStyle
- Defined in pdf/core/annotations/annotation.ts:1747
Parameters
- borderPen: PdfPen
- rectangle: number[]
- borderWidth: number
- Optional parameter: PdfBorderEffect | _PaintParameter
Returns number[]

_populateBezierPoints

_populateBezierPoints(first: number[], second: number[], third: number[], currentIteration: number, bezierPoints: Array<number[]>): void

Inherited from PdfAnnotation._populateBezierPoints
- Defined in pdf/core/annotations/annotation.ts:1997
Parameters
- first: number[]
- second: number[]
- third: number[]
- currentIteration: number
- bezierPoints: Array<number[]>
Returns void

_postProcess

_postProcess(isFlatten: boolean): void

- Defined in pdf/core/annotations/annotation.ts:5575
Parameters
- isFlatten: boolean
Returns void

_prepareButt

_prepareButt(axisPoint: number[], angle: number, length: number): { first: number[]; second: number[] }

Inherited from PdfAnnotation._prepareButt
- Defined in pdf/core/annotations/annotation.ts:2096
Parameters
- axisPoint: number[]
- angle: number
- length: number
Returns { first: number[]; second: number[] }
- first: number[]
- second: number[]

_prepareClosedArrow

_prepareClosedArrow(isBegin: boolean, axisPoint: number[], angle: number, length: number): { first: number[]; second: number[]; startPoint: number[] }

Inherited from PdfAnnotation._prepareClosedArrow
- Defined in pdf/core/annotations/annotation.ts:2064
Parameters
- isBegin: boolean
- axisPoint: number[]
- angle: number
- length: number
Returns { first: number[]; second: number[]; startPoint: number[] }
- first: number[]
- second: number[]
- startPoint: number[]

_prepareDiamond

_prepareDiamond(axisPoint: number[], length: number): { first: number[]; fourth: number[]; second: number[]; third: number[] }

Inherited from PdfAnnotation._prepareDiamond
- Defined in pdf/core/annotations/annotation.ts:2088
Parameters
- axisPoint: number[]
- length: number
Returns { first: number[]; fourth: number[]; second: number[]; third: number[] }
- first: number[]
- fourth: number[]
- second: number[]
- third: number[]

_prepareOpenArrow

_prepareOpenArrow(isBegin: boolean, axisPoint: number[], angle: number, length: number): { first: number[]; second: number[]; startPoint: number[] }

Inherited from PdfAnnotation._prepareOpenArrow
- Defined in pdf/core/annotations/annotation.ts:2046
Parameters
- isBegin: boolean
- axisPoint: number[]
- angle: number
- length: number
Returns { first: number[]; second: number[]; startPoint: number[] }
- first: number[]
- second: number[]
- startPoint: number[]

_prepareReverseCloseArrow

_prepareReverseCloseArrow(isBegin: boolean, axisPoint: number[], angle: number, length: number): { first: number[]; second: number[]; startPoint: number[] }

Inherited from PdfAnnotation._prepareReverseCloseArrow
- Defined in pdf/core/annotations/annotation.ts:2073
Parameters
- isBegin: boolean
- axisPoint: number[]
- angle: number
- length: number
Returns { first: number[]; second: number[]; startPoint: number[] }
- first: number[]
- second: number[]
- startPoint: number[]

_prepareReverseOpenArrow

_prepareReverseOpenArrow(isBegin: boolean, axisPoint: number[], angle: number, length: number): { first: number[]; second: number[]; startPoint: number[] }

Inherited from PdfAnnotation._prepareReverseOpenArrow
- Defined in pdf/core/annotations/annotation.ts:2055
Parameters
- isBegin: boolean
- axisPoint: number[]
- angle: number
- length: number
Returns { first: number[]; second: number[]; startPoint: number[] }
- first: number[]
- second: number[]
- startPoint: number[]

_prepareSlash

_prepareSlash(axisPoint: number[], angle: number, length: number): { first: number[]; second: number[] }

Inherited from PdfAnnotation._prepareSlash
- Defined in pdf/core/annotations/annotation.ts:2082
Parameters
- axisPoint: number[]
- angle: number
- length: number
Returns { first: number[]; second: number[] }
- first: number[]
- second: number[]

_removeAnnotation

_removeAnnotation(page: PdfPage, annotation: PdfAnnotation): void

Inherited from PdfAnnotation._removeAnnotation
- Defined in pdf/core/annotations/annotation.ts:1598
Parameters
- page: PdfPage
- annotation: PdfAnnotation
Returns void

_saveGraphics

_saveGraphics(_page: PdfPage, blendMode: PdfBlendMode): void

Inherited from PdfAnnotation._saveGraphics
- Defined in pdf/core/annotations/annotation.ts:2703
Parameters
- _page: PdfPage
- blendMode: PdfBlendMode
Returns void

_stringToDate

_stringToDate(date: string): Date

Inherited from PdfAnnotation._stringToDate
- Defined in pdf/core/annotations/annotation.ts:2710
Parameters
- date: string
Returns Date

_validateTemplateMatrix

_validateTemplateMatrix(dictionary: _PdfDictionary): boolean
_validateTemplateMatrix(dictionary: _PdfDictionary, template: PdfTemplate): boolean

Inherited from PdfAnnotation._validateTemplateMatrix
- Defined in pdf/core/annotations/annotation.ts:1258
Parameters
- dictionary: _PdfDictionary
Returns boolean
Inherited from PdfAnnotation._validateTemplateMatrix
- Defined in pdf/core/annotations/annotation.ts:1259
Parameters
- dictionary: _PdfDictionary
- template: PdfTemplate
Returns boolean

getValues

getValues(name: string): string[]

Gets the values associated with the specified key.

Parameters

name: string

Key.

Returns string[]

Values associated with the key.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Gets the values associated with the key 'Author'.
let values: string[] = document.getPage(0).annotations.at(0).getValues('Author');
// Save the document
document.save('output.pdf');
// Destroy the document
document.destroy();

setAppearance

setAppearance(value: boolean): void

Set the boolean flag to create a new appearance stream for annotations.

Parameters

value: boolean

Set appearance.

Returns void

Nothing.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Set the boolean flag to create a new appearance stream for annotations.
document.getPage(0).annotations.at(0).setAppearance(true);
// Save the document
document.save('output.pdf');
// Destroy the document
document.destroy();

setValues

setValues(name: string, value: string): void

Sets the values associated with the specified key.

Parameters

name: string

Key.
value: string

Value associated with the key..

Returns void

Nothing.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Access the annotation at index 0
let annotation: PdfAnnotation = document.getPage(0).annotations.at(0);
// Set Unknown state and model
annotation.setValues('State', 'StateModel');
annotation.setValues('StateModel', 'CustomState');
// Save the document
document.save('output.pdf');
// Destroy the document
document.destroy();

Static _load

_load(page: PdfPage, dictionary: _PdfDictionary): PdfPolygonAnnotation

- Defined in pdf/core/annotations/annotation.ts:5566
Parameters
- page: PdfPage
- dictionary: _PdfDictionary
Returns PdfPolygonAnnotation

Generated using TypeDoc

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

Private constructor

Returns PdfPolygonAnnotation

Parameters

points: number[]

Returns PdfPolygonAnnotation

Properties

_annotFlags

_appearanceTemplate

_authorBoldFont

_borderEffect

_bounds

Type declaration

height: number

width: number

x: number

y: number

_circleCaptionFont

_color

_comments

_crossReference

_da

_dictionary

_flatten

_innerColor

Private _intensity

_isAllRotation

_isBounds

_isChanged

_isExport

_isFlattenPopups

_isImported

_isLoaded

_isRotated

_isTransparentColor

_isWidget

_lineCaptionFont

Private _lineExtension

_locationDisplaced

_opacity

_page

_pdfFont

Private _points

_popUpFont

_ref

_reviewHistory

_rotate

_setAppearance

_text

_type

_value

Accessors

_degreeToRadian

Returns number

_hasFlags

Returns boolean

author

Returns string

Parameters

value: string

Returns void

border

Returns PdfAnnotationBorder

Parameters

value: PdfAnnotationBorder

Returns void

borderEffect

Returns PdfBorderEffect

Parameters

value: PdfBorderEffect

Returns void

bounds

Returns { height: number; width: number; x: number; y: number }

height: number