@syncfusion/ej2-pdf-export 29.2.4 → 30.1.37

package/dist/ts/implementation/annotations/annotation.d.ts

@@ -0,0 +1,152 @@
+import { IPdfWrapper } from './../../interfaces/i-pdf-wrapper';
+import { IPdfPrimitive } from './../../interfaces/i-pdf-primitives';
+import { PdfColor } from './../graphics/pdf-color';
+import { RectangleF } from './../drawing/pdf-drawing';
+import { PdfPage } from './../pages/pdf-page';
+import { PdfPageBase } from './../pages/pdf-page-base';
+import { PdfDictionary } from './../primitives/pdf-dictionary';
+import { DictionaryProperties } from './../input-output/pdf-dictionary-properties';
+import { PdfBrush } from './../graphics/brushes/pdf-brush';
+import { PdfFont } from './../graphics/fonts/pdf-font';
+import { PdfStringFormat } from './../graphics/fonts/pdf-string-format';
+/**
+ * `PdfAnnotation` class represents the base class for annotation objects.
+ * @private
+ */
+export declare abstract class PdfAnnotation implements IPdfWrapper {
+    /**
+     * Specifies the Internal variable to store fields of `PdfDictionaryProperties`.
+     * @private
+     */
+    protected dictionaryProperties: DictionaryProperties;
+    /**
+     * `Color` of the annotation
+     * @private
+     */
+    private pdfColor;
+    /**
+     * `Bounds` of the annotation.
+     * @private
+     */
+    private rectangle;
+    /**
+     * Parent `page` of the annotation.
+     * @private
+     */
+    private pdfPage;
+    /**
+     * `Brush of the text` of the annotation.
+     * @default new PdfSolidBrush(new PdfColor(0, 0, 0))
+     * @private
+     */
+    private textBrush;
+    /**
+     * `Font of the text` of the annotation.
+     * @default new PdfStandardFont(PdfFontFamily.TimesRoman, 10)
+     * @private
+     */
+    private textFont;
+    /**
+     * `StringFormat of the text` of the annotation.
+     * @default new PdfStringFormat(PdfTextAlignment.Left)
+     * @private
+     */
+    private format;
+    /**
+     * `Text` of the annotation.
+     * @private
+     */
+    private content;
+    /**
+     * Internal variable to store `dictionary`.
+     * @private
+     */
+    private pdfDictionary;
+    /**
+     * To specifying the `Inner color` with which to fill the annotation
+     * @private
+     */
+    private internalColor;
+    /**
+     * `opacity or darkness` of the annotation.
+     * @private
+     * @default 1.0
+     */
+    private darkness;
+    /**
+     * `Color` of the annotation
+     * @private
+     */
+    color: PdfColor;
+    /**
+     * To specifying the `Inner color` with which to fill the annotation
+     * @private
+     */
+    innerColor: PdfColor;
+    /**
+     * `bounds` of the annotation.
+     * @private
+     */
+    bounds: RectangleF;
+    /**
+     * Parent `page` of the annotation.
+     * @private
+     */
+    readonly page: PdfPage;
+    /**
+     * To specifying the `Font of the text` in the annotation.
+     * @private
+     */
+    font: PdfFont;
+    /**
+     * To specifying the `StringFormat of the text` in the annotation.
+     * @private
+     */
+    stringFormat: PdfStringFormat;
+    /**
+     * To specifying the `Brush of the text` in the annotation.
+     * @private
+     */
+    brush: PdfBrush;
+    /**
+     * `Text` of the annotation.
+     * @private
+     */
+    text: string;
+    /**
+     * Internal variable to store `dictionary`.
+     * @hidden
+     */
+    dictionary: PdfDictionary;
+    /**
+     * Object initialization for `Annotation` class
+     * @private
+     */
+    constructor();
+    constructor(bounds: RectangleF);
+    /**
+     * `Initialize` the annotation event handler and specifies the type of the annotation.
+     * @private
+     */
+    protected initialize(): void;
+    /**
+     * Sets related `page` of the annotation.
+     * @private
+     */
+    setPage(page: PdfPageBase): void;
+    /**
+     * Handles the `BeginSave` event of the Dictionary.
+     * @private
+     */
+    beginSave(): void;
+    /**
+     * `Saves` an annotation.
+     * @private
+     */
+    protected save(): void;
+    /**
+     * Gets the `element`.
+     * @private
+     */
+    readonly element: IPdfPrimitive;
+}

package/dist/ts/implementation/annotations/annotation.ts

@@ -0,0 +1,241 @@
+import { IPdfWrapper } from './../../interfaces/i-pdf-wrapper';
+import { IPdfPrimitive } from './../../interfaces/i-pdf-primitives';
+import { PdfColor } from './../graphics/pdf-color';
+import { RectangleF, PointF } from './../drawing/pdf-drawing';
+import { PdfPage } from './../pages/pdf-page';
+import { PdfPageBase } from './../pages/pdf-page-base';
+import { PdfDictionary, SaveAnnotationEventHandler } from './../primitives/pdf-dictionary';
+import { PdfArray } from './../primitives/pdf-array';
+import { PdfNumber } from './../primitives/pdf-number';
+import { PdfReferenceHolder } from './../primitives/pdf-reference';
+import { PdfString } from './../primitives/pdf-string';
+import { DictionaryProperties } from './../input-output/pdf-dictionary-properties';
+import { PdfName } from './../primitives/pdf-name';
+import { PdfSection } from './../pages/pdf-section';
+import { PdfBrush } from './../graphics/brushes/pdf-brush';
+import { PdfSolidBrush } from './../graphics/brushes/pdf-solid-brush';
+import { PdfStandardFont } from './../graphics/fonts/pdf-standard-font';
+import { PdfFont } from './../graphics/fonts/pdf-font';
+import { PdfFontFamily } from './../graphics/fonts/enum';
+import { PdfStringFormat } from './../graphics/fonts/pdf-string-format';
+import { PdfTextAlignment } from './../graphics/enum';
+/**
+ * `PdfAnnotation` class represents the base class for annotation objects.
+ * @private
+ */
+export abstract class PdfAnnotation implements IPdfWrapper {
+    // Fields
+    /**
+     * Specifies the Internal variable to store fields of `PdfDictionaryProperties`.
+     * @private
+     */
+    protected dictionaryProperties : DictionaryProperties = new DictionaryProperties();
+    /**
+     * `Color` of the annotation
+     * @private
+     */
+    private pdfColor : PdfColor = new PdfColor(255, 255, 255);
+    /**
+     * `Bounds` of the annotation.
+     * @private
+     */
+    private rectangle : RectangleF = new RectangleF(0, 0, 0, 0);
+    /**
+     * Parent `page` of the annotation.
+     * @private
+     */
+    private pdfPage : PdfPage = null;
+    /**
+     * `Brush of the text` of the annotation.
+     * @default new PdfSolidBrush(new PdfColor(0, 0, 0))
+     * @private
+     */
+    private textBrush : PdfBrush = new PdfSolidBrush(new PdfColor(0, 0, 0));
+    /**
+     * `Font of the text` of the annotation.
+     * @default new PdfStandardFont(PdfFontFamily.TimesRoman, 10)
+     * @private
+     */
+    private textFont : PdfFont = new PdfStandardFont(PdfFontFamily.TimesRoman, 10);
+    /**
+     * `StringFormat of the text` of the annotation.
+     * @default new PdfStringFormat(PdfTextAlignment.Left)
+     * @private
+     */
+    private format : PdfStringFormat = new PdfStringFormat(PdfTextAlignment.Left);
+    /**
+     * `Text` of the annotation.
+     * @private
+     */
+    private content : string = '';
+    /**
+     * Internal variable to store `dictionary`.
+     * @private
+     */
+    private pdfDictionary : PdfDictionary = new PdfDictionary();
+    /**
+     * To specifying the `Inner color` with which to fill the annotation
+     * @private
+     */
+    private internalColor : PdfColor = new PdfColor();
+    /**
+     * `opacity or darkness` of the annotation.
+     * @private
+     * @default 1.0
+     */
+    private darkness : number = 1.0;
+    // Properties
+    /**
+     * `Color` of the annotation
+     * @private
+     */
+    public get color() : PdfColor {
+        return this.pdfColor;
+    }
+    public set color(value : PdfColor) {
+        this.pdfColor = value;
+    }
+    /**
+     * To specifying the `Inner color` with which to fill the annotation
+     * @private
+     */
+    public get innerColor() : PdfColor {
+        return this.internalColor;
+    }
+    public set innerColor(value : PdfColor) {
+        this.internalColor = value;
+    }
+    /**
+     * `bounds` of the annotation.
+     * @private
+     */
+    public get bounds() : RectangleF {
+        return this.rectangle;
+    }
+    public set bounds(value : RectangleF) {
+        this.rectangle = value;
+    }
+    /**
+     * Parent `page` of the annotation.
+     * @private
+     */
+    public get page() : PdfPage {
+        return this.pdfPage;
+    }
+    /**
+     * To specifying the `Font of the text` in the annotation.
+     * @private
+     */
+    public get font() : PdfFont {
+        return this.textFont;
+    }
+    public set font(value : PdfFont) {
+        this.textFont = value;
+    }
+    /**
+     * To specifying the `StringFormat of the text` in the annotation.
+     * @private
+     */
+    public get stringFormat() : PdfStringFormat {
+        return this.format;
+    }
+    public set stringFormat(value : PdfStringFormat) {
+        this.format = value;
+    }
+    /**
+     * To specifying the `Brush of the text` in the annotation.
+     * @private
+     */
+    public get brush() : PdfBrush {
+        return this.textBrush;
+    }
+    public set brush(value : PdfBrush) {
+        this.textBrush = value;
+    }
+    /**
+     * `Text` of the annotation.
+     * @private
+     */
+    public get text() : string {
+        return this.content;
+    }
+    public set text(value : string) {
+        this.content = value;
+        this.dictionary.items.setValue(this.dictionaryProperties.contents, new PdfString(this.content));
+    }
+    /**
+     * Internal variable to store `dictionary`.
+     * @hidden
+     */
+    public get dictionary() : PdfDictionary {
+        return this.pdfDictionary;
+    }
+    public set dictionary(value : PdfDictionary) {
+        this.pdfDictionary = value;
+    }
+    // Constructors
+    /**
+     * Object initialization for `Annotation` class
+     * @private
+     */
+    public constructor()
+    public constructor(bounds : RectangleF)
+    public constructor(arg1 ?: RectangleF) {
+        if (typeof arg1 === 'undefined') {
+            this.initialize();
+        } else {
+            this.initialize();
+            this.bounds = arg1;
+        }
+    }
+    // Implementation
+    /**
+     * `Initialize` the annotation event handler and specifies the type of the annotation.
+     * @private
+     */
+    protected initialize() : void {
+        this.pdfDictionary.annotationBeginSave = new SaveAnnotationEventHandler(this);
+        this.pdfDictionary.items.setValue(this.dictionaryProperties.type, new PdfName(this.dictionaryProperties.annot));
+    }
+    /**
+     * Sets related `page` of the annotation.
+     * @private
+     */
+    public setPage(page : PdfPageBase) : void {
+        this.pdfPage = page as PdfPage;
+        this.pdfDictionary.items.setValue(this.dictionaryProperties.p, new PdfReferenceHolder(this.pdfPage));
+    }
+    /**
+     * Handles the `BeginSave` event of the Dictionary.
+     * @private
+     */
+    public beginSave() : void {
+        this.save();
+    }
+    /**
+     * `Saves` an annotation.
+     * @private
+     */
+    /* tslint:disable */
+    protected save() : void {
+        let nativeRectangle : RectangleF = new RectangleF(this.rectangle.x, this.rectangle.y, this.rectangle.width, this.rectangle.height);
+        let section : PdfSection = this.pdfPage.section;
+        let initialHeight : number = nativeRectangle.height;
+        let tempLoacation : PointF = section.pointToNativePdf(this.page, new PointF(nativeRectangle.x, nativeRectangle.y));
+        nativeRectangle.x = tempLoacation.x;
+        nativeRectangle.width = tempLoacation.x + nativeRectangle.width;
+        nativeRectangle.y = (tempLoacation.y - this.page.document.pageSettings.margins.top);
+        nativeRectangle.height = nativeRectangle.y - initialHeight;
+        this.pdfDictionary.items.setValue(this.dictionaryProperties.rect, PdfArray.fromRectangle(nativeRectangle));
+        this.dictionary.items.setValue(this.dictionaryProperties.ca, new PdfNumber(this.darkness));
+    }
+    /* tslint:enable */
+    // IPdfWrapper Members
+    /**
+     * Gets the `element`.
+     * @private
+     */
+    public get element() : IPdfPrimitive {
+        return this.pdfDictionary;
+    }
+}

package/dist/ts/implementation/annotations/document-link-annotation.d.ts

@@ -0,0 +1,89 @@
+import { PdfLinkAnnotation } from './link-annotation';
+import { RectangleF } from './../drawing/pdf-drawing';
+import { PdfDestination } from './../general/pdf-destination';
+/**
+ * `PdfDocumentLinkAnnotation` class represents an annotation object with holds link on another location within a document.
+ * ```typescript
+ * // create a new PDF document
+ * let document : PdfDocument = new PdfDocument();
+ * // create new pages
+ * let page1 : PdfPage = document.pages.add();
+ * let page2 : PdfPage = document.pages.add();
+ * // create a new rectangle
+ * let bounds : RectangleF = new RectangleF({x : 10, y : 200}, {width : 300, height : 25});
+ * //
+ * // create a new document link annotation
+ * let documentLinkAnnotation : PdfDocumentLinkAnnotation = new PdfDocumentLinkAnnotation(bounds);
+ * // set the annotation text
+ * documentLinkAnnotation.text = 'Document link annotation';
+ * // set the destination
+ * documentLinkAnnotation.destination = new PdfDestination(page2);
+ * // set the documentlink annotation location
+ * documentLinkAnnotation.destination.location = new PointF(10, 0);
+ * // add this annotation to a new page
+ * page1.annotations.add(documentLinkAnnotation);
+ * //
+ * // save the document to disk
+ * document.save('output.pdf');
+ * // destroy the document
+ * document.destroy();
+ * ```
+ */
+export declare class PdfDocumentLinkAnnotation extends PdfLinkAnnotation {
+    /**
+     * `Destination` of the annotation.
+     * @default null
+     * @private
+     */
+    private pdfDestination;
+    /**
+     * Gets or sets the `destination` of the annotation.
+     * ```typescript
+     * // create a new PDF document
+     * let document : PdfDocument = new PdfDocument();
+     * // create new pages
+     * let page1 : PdfPage = document.pages.add();
+     * let page2 : PdfPage = document.pages.add();
+     * // create a new rectangle
+     * let bounds : RectangleF = new RectangleF({x : 10, y : 200}, {width : 300, height : 25});
+     * //
+     * // create a new document link annotation
+     * let documentLinkAnnotation : PdfDocumentLinkAnnotation = new PdfDocumentLinkAnnotation(bounds);
+     * // set the annotation text
+     * documentLinkAnnotation.text = 'Document link annotation';
+     * // set the destination
+     * documentLinkAnnotation.destination = new PdfDestination(page2);
+     * // set the documentlink annotation location
+     * documentLinkAnnotation.destination.location = new PointF(10, 0);
+     * // add this annotation to a new page
+     * page1.annotations.add(documentLinkAnnotation);
+     * //
+     * // save the document to disk
+     * document.save('output.pdf');
+     * // destroy the document
+     * document.destroy();
+     * ```
+     * @default null
+     */
+    destination: PdfDestination;
+    /**
+     * Initializes new `PdfDocumentLinkAnnotation` instance with specified bounds.
+     * @private
+     */
+    constructor(rectangle: RectangleF);
+    /**
+     * Initializes new `PdfDocumentLinkAnnotation` instance with specified bounds and destination.
+     * @private
+     */
+    constructor(rectangle: RectangleF, destination: PdfDestination);
+    /**
+     * `Saves` annotation object.
+     * @private
+     */
+    save(): void;
+    /**
+     * `Clone` the document link annotation.
+     * @private
+     */
+    clone(): PdfDocumentLinkAnnotation;
+}

package/dist/ts/implementation/annotations/document-link-annotation.ts

@@ -0,0 +1,118 @@
+import { PdfLinkAnnotation } from './link-annotation';
+import { RectangleF } from './../drawing/pdf-drawing';
+import { PdfDestination } from './../general/pdf-destination';
+/**
+ * `PdfDocumentLinkAnnotation` class represents an annotation object with holds link on another location within a document.
+ * ```typescript
+ * // create a new PDF document
+ * let document : PdfDocument = new PdfDocument();
+ * // create new pages
+ * let page1 : PdfPage = document.pages.add();
+ * let page2 : PdfPage = document.pages.add();
+ * // create a new rectangle
+ * let bounds : RectangleF = new RectangleF({x : 10, y : 200}, {width : 300, height : 25});
+ * //
+ * // create a new document link annotation
+ * let documentLinkAnnotation : PdfDocumentLinkAnnotation = new PdfDocumentLinkAnnotation(bounds);
+ * // set the annotation text
+ * documentLinkAnnotation.text = 'Document link annotation';
+ * // set the destination
+ * documentLinkAnnotation.destination = new PdfDestination(page2);
+ * // set the documentlink annotation location
+ * documentLinkAnnotation.destination.location = new PointF(10, 0);
+ * // add this annotation to a new page
+ * page1.annotations.add(documentLinkAnnotation);
+ * //
+ * // save the document to disk
+ * document.save('output.pdf');
+ * // destroy the document
+ * document.destroy();
+ * ```
+ */
+export class PdfDocumentLinkAnnotation extends PdfLinkAnnotation {
+    // Fields
+    /**
+     * `Destination` of the annotation.
+     * @default null
+     * @private
+     */
+    private pdfDestination : PdfDestination = null;
+    // Properties
+    /**
+     * Gets or sets the `destination` of the annotation.
+     * ```typescript
+     * // create a new PDF document
+     * let document : PdfDocument = new PdfDocument();
+     * // create new pages
+     * let page1 : PdfPage = document.pages.add();
+     * let page2 : PdfPage = document.pages.add();
+     * // create a new rectangle
+     * let bounds : RectangleF = new RectangleF({x : 10, y : 200}, {width : 300, height : 25});
+     * //
+     * // create a new document link annotation
+     * let documentLinkAnnotation : PdfDocumentLinkAnnotation = new PdfDocumentLinkAnnotation(bounds);
+     * // set the annotation text
+     * documentLinkAnnotation.text = 'Document link annotation';
+     * // set the destination
+     * documentLinkAnnotation.destination = new PdfDestination(page2);
+     * // set the documentlink annotation location
+     * documentLinkAnnotation.destination.location = new PointF(10, 0);
+     * // add this annotation to a new page
+     * page1.annotations.add(documentLinkAnnotation);
+     * //
+     * // save the document to disk
+     * document.save('output.pdf');
+     * // destroy the document
+     * document.destroy();
+     * ```
+     * @default null
+     */
+    public get destination() : PdfDestination {
+        return this.pdfDestination;
+    }
+    public set destination(value : PdfDestination) {
+        // if (this.pdfDestination !== value) {
+        this.pdfDestination = value;
+        // }
+    }
+    // Constructors
+    /**
+     * Initializes new `PdfDocumentLinkAnnotation` instance with specified bounds.
+     * @private
+     */
+    public constructor(rectangle : RectangleF)
+    /**
+     * Initializes new `PdfDocumentLinkAnnotation` instance with specified bounds and destination.
+     * @private
+     */
+    public constructor(rectangle : RectangleF, destination : PdfDestination)
+    public constructor(rectangle : RectangleF, destination ?: PdfDestination) {
+        super(rectangle);
+        if (typeof destination !== 'undefined') {
+            this.destination = destination;
+        }
+    }
+    // Implementation
+    /**
+     * `Saves` annotation object.
+     * @private
+     */
+    public save() : void {
+        super.save();
+        if (this.pdfDestination != null) {
+            this.dictionary.items.setValue(this.dictionaryProperties.dest, this.pdfDestination.element);
+        }
+    }
+    /**
+     * `Clone` the document link annotation.
+     * @private
+     */
+    public clone() : PdfDocumentLinkAnnotation {
+        let annot : PdfDocumentLinkAnnotation = new PdfDocumentLinkAnnotation(this.bounds, this.destination);
+        annot.color = this.color;
+        annot.brush = this.brush;
+        annot.destination = this.destination;
+        annot.font = this.font;
+        return annot;
+    }
+}

package/dist/ts/implementation/annotations/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Annotations classes
+ * @hidden
+ */
+export * from './action-link-annotation';
+export * from './annotation';
+export * from './annotation-collection';
+export * from './document-link-annotation';
+export * from './link-annotation';
+export * from './pdf-text-web-link';
+export * from './uri-annotation';

package/dist/ts/implementation/annotations/index.ts

@@ -0,0 +1,11 @@
+/**
+ * Annotations classes
+ * @hidden
+ */
+export * from './action-link-annotation';
+export * from './annotation';
+export * from './annotation-collection';
+export * from './document-link-annotation';
+export * from './link-annotation';
+export * from './pdf-text-web-link';
+export * from './uri-annotation';

package/dist/ts/implementation/annotations/link-annotation.d.ts

@@ -0,0 +1,23 @@
+import { PdfAnnotation } from './annotation';
+import { RectangleF } from './../drawing/pdf-drawing';
+/**
+ * `PdfLinkAnnotation` class represents the ink annotation class.
+ * @private
+ */
+export declare abstract class PdfLinkAnnotation extends PdfAnnotation {
+    /**
+     * Initializes new instance of `PdfLineAnnotation` class with specified points.
+     * @private
+     */
+    constructor();
+    /**
+     * Initializes new instance of `PdfLineAnnotation` class with set of points and annotation text.
+     * @private
+     */
+    constructor(rectangle: RectangleF);
+    /**
+     * `Initializes` annotation object.
+     * @private
+     */
+    protected initialize(): void;
+}

package/dist/ts/implementation/annotations/link-annotation.ts

@@ -0,0 +1,32 @@
+import { PdfAnnotation } from './annotation';
+import { RectangleF } from './../drawing/pdf-drawing';
+import { PdfName } from './../primitives/pdf-name';
+/**
+ * `PdfLinkAnnotation` class represents the ink annotation class.
+ * @private
+ */
+export abstract class PdfLinkAnnotation extends PdfAnnotation {
+    // Constructors
+    /**
+     * Initializes new instance of `PdfLineAnnotation` class with specified points.
+     * @private
+     */
+    public constructor()
+    /**
+     * Initializes new instance of `PdfLineAnnotation` class with set of points and annotation text.
+     * @private
+     */
+    public constructor(rectangle : RectangleF)
+    public constructor(rectangle ?: RectangleF) {
+        super(rectangle);
+    }
+    // Implementation
+    /**
+     * `Initializes` annotation object.
+     * @private
+     */
+    protected initialize() : void {
+        super.initialize();
+        this.dictionary.items.setValue(this.dictionaryProperties.subtype, new PdfName(this.dictionaryProperties.link));
+    }
+}