@syncfusion/ej2-pdf-export 21.2.8 → 22.1.34

package/dist/ts/implementation/drawing/pdf-drawing.ts

@@ -0,0 +1,218 @@
+/**
+ * Coordinates of Position for `PointF`.
+ * @private
+ */
+export class PointF {
+    /**
+     * Value of `X`.
+     * @private
+     */
+    public x : number;
+    /**
+     * Value of `Y`.
+     * @private
+     */
+    public y : number;
+    //public static readonly empty : PointF = new PointF(0, 0);
+    /**
+     * Instance of `PointF` class.
+     * @private
+     */
+    constructor()
+    /**
+     * Instance of `PointF` class with X, Y co-ordinates.
+     * @private
+     */
+    constructor(x : number, y : number)
+    constructor(x? : number, y? : number) {
+        if (typeof x === 'undefined') {
+            this.x = 0;
+            this.y = 0;
+        } else {
+            if (x !== null) {
+                this.x = x;
+            } else {
+                this.x = 0;
+            }
+            if (y !== null) {
+                this.y = y;
+            } else {
+                this.y = 0;
+            }
+        }
+    }
+}
+/**
+ * Width and Height as `Size`.
+ * @private
+ */
+export class SizeF {
+    /**
+     * Value of ``Height``.
+     * @private
+     */
+    public height : number;
+    /**
+     * Value of `Width`.
+     * @private
+     */
+    public width : number;
+    //public static readonly empty : SizeF = new SizeF(0, 0);
+    /**
+     * Instance of `SizeF` class.
+     * @private
+     */
+    constructor()
+    /**
+     * Instance of `SizeF` class with Width and Height.
+     * @private
+     */
+    constructor(width : number, height : number)
+    constructor(width? : number, height? : number) {
+        if (typeof height === 'undefined') {
+            this.height = 0;
+            this.width = 0;
+        } else {
+            if (height !== null) {
+                this.height = height;
+            } else {
+                this.height = 0;
+            }
+            if (width !== null) {
+                this.width = width;
+            } else {
+                this.width = 0;
+            }
+        }
+    }
+}
+/**
+ * `RectangleF` with Position and size.
+ * @private
+ */
+export class RectangleF {
+    /**
+     * Value of `X`.
+     * @private
+     */
+    public x : number;
+    /**
+     * Value of `Y`.
+     * @private
+     */
+    public y : number;
+    /**
+     * Value of `Height`.
+     * @private
+     */
+    public height : number;
+    /**
+     * Value of `Width`.
+     * @private
+     */
+    public width : number;
+    /**
+     * Instance of `RectangleF` class.
+     * @private
+     */
+    public constructor()
+    /**
+     * Instance of `RectangleF` class with X, Y, Width and Height.
+     * @private
+     */
+    public constructor(x : number, y : number, height : number, width : number)
+    /**
+     * Instance of `RectangleF` class with PointF, SizeF.
+     * @private
+     */
+    public constructor(pointF : PointF, sizeF : SizeF)
+    public constructor(arg1? : PointF | number, arg2? : SizeF | number, arg3 ?: number, arg4 ?: number ) {
+        if (typeof arg1 === typeof arg1 && typeof arg1 === 'undefined') {
+            this.x = 0;
+            this.y = 0;
+            this.height = 0;
+            this.width = 0;
+        } else {
+            if (arg1 instanceof PointF && arg2 instanceof SizeF && typeof arg3 === 'undefined') {
+                let pointf : PointF = arg1 as PointF;
+                this.x = pointf.x;
+                this.y = pointf.y;
+                let sizef : SizeF = arg2 as SizeF;
+                this.height = sizef.height;
+                this.width = sizef.width;
+            } else {
+                let x : number = arg1 as number;
+                let y : number = arg2 as number;
+                let width : number = arg3 as number;
+                let height : number = arg4 as number;
+                this.x = x;
+                this.y = y;
+                this.height = height;
+                this.width = width;
+            }
+        }
+    }
+}
+/**
+ * `Rectangle` with left, right, top and bottom.
+ * @private
+ */
+export class Rectangle {
+    /**
+     * Value of `left`.
+     * @private
+     */
+    public left : number;
+    /**
+     * Value of `top`.
+     * @private
+     */
+    public top : number;
+    /**
+     * Value of `right`.
+     * @private
+     */
+    public right : number;
+    /**
+     * Value of `bottom`.
+     * @private
+     */
+    public bottom : number;
+    /**
+     * Instance of `RectangleF` class with X, Y, Width and Height.
+     * @private
+     */
+    public constructor(left : number, top : number, right : number, bottom : number) {
+        this.left = left;
+        this.top = top;
+        this.right = right;
+        this.bottom = bottom;
+    }
+    /**
+     * Gets a value of width
+     */
+    public get width() : number {
+        return this.right - this.left;
+    }
+    /**
+     * Gets a value of height
+     */
+    public get height() : number {
+        return this.bottom - this.top;
+    }
+    /**
+     * Gets a value of Top and Left
+     */
+    public get topLeft() : PointF {
+        return new PointF(this.left, this.top);
+    }
+    /**
+     * Gets a value of size
+     */
+    public get size() : SizeF {
+        return new SizeF(this.width, this.height);
+    }
+    public toString() : string {
+        return this.topLeft + 'x' + this.size;
+    }
+}

package/dist/ts/implementation/general/enum.ts

@@ -0,0 +1,21 @@
+/**
+ * public Enum for `PdfDestinationMode`.
+ * @private
+ */
+export enum PdfDestinationMode {
+    /**
+     * Specifies the type of `Location`.
+     * @private
+     */
+    Location,
+    /**
+     * Specifies the type of `FitToPage`.
+     * @private
+     */
+    FitToPage,
+    /**
+     * Specifies the type of `FitR`.
+     * @private
+     */
+    FitR
+}

package/dist/ts/implementation/general/functions/pdf-function.ts

@@ -0,0 +1,66 @@
+/**
+ * PdfFunction.ts class for EJ2-PDF
+ * Implements the base class for all functions.
+ */
+import { PdfDictionary } from '../../primitives/pdf-dictionary';
+import { IPdfWrapper} from '../../../interfaces/i-pdf-wrapper';
+import { DictionaryProperties } from './../../input-output/pdf-dictionary-properties';
+import { PdfArray } from './../../primitives/pdf-array';
+import { IPdfPrimitive } from './../../../interfaces/i-pdf-primitives';
+export abstract class PdfFunction implements IPdfWrapper {
+    //Field
+    /**
+     * Internal variable to store dictionary.
+     * @private
+     */
+    private mDictionary: PdfDictionary = null;
+    /**
+     * Local variable to store the dictionary properties.
+     * @private
+     */
+    protected mDictionaryProperties : DictionaryProperties = new DictionaryProperties();
+    //Constructor
+    /**
+     * Initializes a new instance of the `PdfFunction` class.
+     * @public
+     */
+    public constructor(dictionary: PdfDictionary) {
+        this.mDictionary = dictionary;
+    }
+    //Properties
+    /**
+     * Gets or sets the domain of the function.
+     * @public
+     */
+    protected get domain(): PdfArray {
+        let domain: PdfArray = (<PdfArray>this.mDictionary.items.getValue(this.mDictionaryProperties.domain));
+        return domain;
+    }
+    protected set domain(value: PdfArray)  {
+        this.mDictionary.items.setValue(this.mDictionaryProperties.domain, value);
+    }
+    /**
+     * Gets or sets the range.
+     * @public
+     */
+    protected get range(): PdfArray {
+        let range: PdfArray = (<PdfArray>(this.mDictionary.items.getValue(this.mDictionaryProperties.range)));
+        return range;
+    }
+    protected set range(value: PdfArray)  {
+        this.mDictionary.items.setValue(this.mDictionaryProperties.range, value);
+    }
+    /**
+     * Gets the dictionary.
+     */
+    protected get dictionary(): PdfDictionary {
+        return this.mDictionary;
+    }
+    //IPdfWrapper Members
+    /**
+     * Gets the element.
+     */
+    get element(): IPdfPrimitive {
+        return this.mDictionary;
+    }
+}

package/dist/ts/implementation/general/functions/pdf-sampled-function.ts

@@ -0,0 +1,62 @@
+/**
+ * PdfSampledFunction.ts class for EJ2-PDF
+ * Implements PDF Sampled Function.
+ */
+import { PdfArray } from './../../primitives/pdf-array';
+import { PdfFunction} from './pdf-function';
+import { PdfStream } from './../../primitives/pdf-stream';
+import { PdfNumber} from './../../primitives/pdf-number';
+export class PdfSampledFunction extends PdfFunction {
+    //Constructor
+    /**
+     * Initializes a new instance of the `PdfSampledFunction` class.
+     * @public
+     */
+    public constructor()
+    /**
+     * Initializes a new instance of the `PdfSampledFunction` class.
+     * @public
+     */
+    public constructor(domain: number[], range: number[], sizes: number[], samples: number[])
+    /**
+     * Initializes a new instance of the `PdfSampledFunction` class.
+     * @public
+     */
+    public constructor(domain?: number[], range?: number[], sizes?: number[], samples?: number[]) {
+        super(new PdfStream());
+        if (typeof domain === 'undefined') {
+            this.dictionary.items.setValue(this.mDictionaryProperties.functionType, new PdfNumber(0));
+        } else {
+            this.dictionary.items.setValue(this.mDictionaryProperties.functionType, new PdfNumber(0));
+            this.checkParams(domain, range, sizes, samples);
+            this.setDomainAndRange(domain, range);
+            this.setSizeAndValues(sizes, samples);
+        }
+    }
+    // Helper methods
+    /**
+     * Checks the input parameters. 
+     */
+    private checkParams(domain: number[], range: number[], sizes: number[], samples: number[]) : void {
+        let rLength: number = range.length;
+        let dLength: number = domain.length;
+        let sLength: number = samples.length;
+        let frameLength: number = (rLength * (dLength / 4));
+    }
+    /**
+     * Sets the domain and range.
+     */
+    private setDomainAndRange(domain: number[], range: number[]) : void {
+        this.domain = new PdfArray(domain);
+        this.range = new PdfArray(range);
+    }
+    /**
+     * Sets the size and values.
+     */
+    private setSizeAndValues(sizes: number[], samples: number[]) : void {
+        let s: PdfStream = (<PdfStream>(this.dictionary));
+        this.dictionary.items.setValue(this.mDictionaryProperties.size, new PdfArray(sizes));
+        this.dictionary.items.setValue(this.mDictionaryProperties.bitsPerSample, new PdfNumber(8));
+        s.writeBytes(samples);
+    }
+}

package/dist/ts/implementation/general/pdf-cache-collection.ts

@@ -0,0 +1,97 @@
+/**
+ * PdfCacheCollection.ts class for EJ2-PDF
+ */
+import { Dictionary } from './../collections/dictionary';
+import { PdfFont } from './../graphics/fonts/pdf-font';
+import { IPdfCache } from './../../interfaces/i-pdf-cache';
+/**
+ * `Collection of the cached objects`.
+ * @private
+ */
+export class PdfCacheCollection {
+    // Fields
+    /**
+     * Stores the similar `objects`.
+     * @private
+     */
+    private referenceObjects : Object[][];
+    /**
+     * Stores the references of font with GUID `objects`.
+     * @private
+     */
+    private pdfFontCollection : Dictionary<string, PdfFont>;
+    // Constructors
+    /**
+     * Initializes a new instance of the `PdfCacheCollection` class.
+     * @private
+     */
+    public constructor() {
+        this.referenceObjects = [];
+        this.pdfFontCollection = new Dictionary<string, PdfFont>();
+    }
+    // Public methods
+    /**
+     * `Searches` for the similar cached object. If is not found - adds the object to the cache.
+     * @private
+     */
+    public search(obj : IPdfCache) : IPdfCache {
+        let result : IPdfCache = null;
+        let group : Object[] = this.getGroup(obj);
+        if (group == null) {
+            group = this.createNewGroup();
+        } else if (group.length > 0) {
+            result = group[0] as IPdfCache;
+        }
+        group.push(obj);
+        return result;
+    }
+    // Implementation
+    /**
+     * `Creates` a new group.
+     * @private
+     */
+    public createNewGroup() : Object[] {
+        let group : Object[] = [];
+        this.referenceObjects.push(group);
+        return group;
+    }
+    /**
+     * `Find and Return` a group.
+     * @private
+     */
+    public getGroup(result : IPdfCache) : Object[] {
+        let group : Object[] = null;
+        if (result !== null) {
+            let len : number = this.referenceObjects.length;
+            for (let i : number = 0; i < len; i++) {
+                if (this.referenceObjects.length > 0) {
+                    let tGroup : Object[] = this.referenceObjects[i];
+                    if (tGroup.length > 0) {
+                        let representative : IPdfCache = tGroup[0] as IPdfCache;
+                        if (result.equalsTo(representative)) {
+                            group = tGroup;
+                            break;
+                        }
+                    } else {
+                        this.removeGroup(tGroup);
+                    }
+                }
+                len = this.referenceObjects.length;
+            }
+        }
+        return group;
+    }
+    /**
+     * Remove a group from the storage.
+     */
+    public removeGroup(group : Object[]) : void {
+        if (group !== null) {
+            let index : number = this.referenceObjects.indexOf(group);
+            this.referenceObjects.slice(index, index + 1);
+        }
+    }
+    public destroy() : void {
+        this.pdfFontCollection = undefined;
+        this.referenceObjects = undefined;
+    }
+}

package/dist/ts/implementation/general/pdf-collection.ts

@@ -0,0 +1,41 @@
+/**
+ * PdfCollection.ts class for EJ2-PDF
+ * The class used to handle the collection of PdF objects.
+ */
+export class PdfCollection {
+    // Fields
+    /**
+     * Stores the `objects` as array.
+     * @private
+     */
+    private collection : Object[];
+    // Constructors
+    /**
+     * Initializes a new instance of the `Collection` class.
+     * @private
+     */
+    public constructor() {
+        //
+    }
+    // Properties
+    /**
+     * Gets the `Count` of stored objects.
+     * @private
+     */
+    public get count() : number {
+        if (typeof this.collection === 'undefined') {
+            this.collection = [];
+        }
+        return this.collection.length;
+    }
+    /**
+     * Gets the `list` of stored objects.
+     * @private
+     */
+    public get list() : Object[] {
+        if (typeof this.collection === 'undefined') {
+            this.collection = [];
+        }
+        return this.collection;
+    }
+}

package/dist/ts/implementation/general/pdf-destination.ts

@@ -0,0 +1,170 @@
+/**
+ * PdfDestination.ts class for EJ2-PDF
+ */
+import { IPdfWrapper } from './../../interfaces/i-pdf-wrapper';
+import { IPdfPrimitive } from './../../interfaces/i-pdf-primitives';
+import { PointF, RectangleF } from './../drawing/pdf-drawing';
+import { PdfPageBase } from './../pages/pdf-page-base';
+import { PdfArray } from './../primitives/pdf-array';
+import { PdfPage } from './../pages/pdf-page';
+import { PdfPageRotateAngle } from './../pages/enum';
+import { PdfDestinationMode } from './../general/enum';
+import { PdfSection } from './../pages/pdf-section';
+import { PdfReferenceHolder } from './../primitives/pdf-reference';
+import { PdfName } from './../primitives/pdf-name';
+import { PdfNumber } from './../primitives/pdf-number';
+import { DictionaryProperties } from './../input-output/pdf-dictionary-properties';
+/**
+ * `PdfDestination` class represents an anchor in the document
+ * where bookmarks or annotations can direct when clicked.
+ */
+export class PdfDestination implements IPdfWrapper {
+    // Fields
+    /**
+     * Internal variable for accessing fields from `DictionryProperties` class.
+     * @private
+     */
+    protected dictionaryProperties : DictionaryProperties = new DictionaryProperties();
+    /**
+     * Type of the `destination`.
+     * @private
+     */
+    private destinationMode : PdfDestinationMode = PdfDestinationMode.Location;
+    /**
+     * `Zoom` factor.
+     * @private
+     * @default 0
+     */
+    private zoomFactor : number = 0;
+    /**
+     * `Location` of the destination.
+     * @default new PointF() with 0 ,0 as co-ordinates
+     * @private
+     */
+    private destinationLocation : PointF = new PointF(0, 0);
+    /**
+     * `Bounds` of the destination as RectangleF.
+     * @default RectangleF.Empty
+     * @private
+     */
+    private bounds : RectangleF = new RectangleF();
+    /**
+     * Parent `page` reference.
+     * @private
+     */
+    private pdfPage : PdfPageBase;
+    /**
+     * Pdf primitive representing `this` object.
+     * @private
+     */
+    private array : PdfArray = new PdfArray();
+    // Constructors
+    /**
+     * Initializes a new instance of the `PdfDestination` class with page object.
+     * @private
+     */
+    public constructor(page : PdfPageBase)
+    /**
+     * Initializes a new instance of the `PdfDestination` class with page object and location.
+     * @private
+     */
+    public constructor(page : PdfPageBase, location : PointF)
+    /**
+     * Initializes a new instance of the `PdfDestination` class with page object and bounds.
+     * @private
+     */
+    public constructor(page : PdfPageBase, rectangle : RectangleF)
+    public constructor(arg1 : PdfPageBase, arg2 ?: RectangleF | PointF) {
+            let angle : PdfPageRotateAngle = PdfPageRotateAngle.RotateAngle0;
+            this.destinationLocation = new PointF(0,  this.destinationLocation.y);
+            this.pdfPage = arg1;
+            if (arg2 instanceof PointF) {
+                this.destinationLocation = arg2;
+            } else {
+                this.bounds = arg2;
+            }
+    }
+    // Properties
+    /**
+     * Gets and Sets the `zoom` factor.
+     * @private
+     */
+    public get zoom() : number {
+        return this.zoomFactor;
+    }
+    public set zoom(value : number) {
+        this.zoomFactor = value;
+        this.initializePrimitive();
+    }
+    /**
+     * Gets and Sets the `page` object.
+     * @private
+     */
+    public get page() : PdfPageBase {
+        return this.pdfPage;
+    }
+    public set page(value : PdfPageBase) {
+        this.pdfPage = value;
+        this.initializePrimitive();
+    }
+    /**
+     * Gets and Sets the destination `mode`.
+     * @private
+     */
+    public get mode() : PdfDestinationMode {
+        return this. destinationMode;
+    }
+    public set mode(value : PdfDestinationMode) {
+        this.destinationMode = value;
+        this.initializePrimitive();
+    }
+    /**
+     * Gets and Sets the `location`.
+     * @private
+     */
+    public get location() : PointF {
+        return this.destinationLocation;
+    }
+    public set location(value : PointF) {
+        this.destinationLocation = value;
+        this.initializePrimitive();
+    }
+    /**
+     * `Translates` co-ordinates to PDF co-ordinate system (lower/left).
+     * @private
+     */
+    private pointToNativePdf(page : PdfPage, point : PointF) : PointF {
+        let section : PdfSection = page.section;
+        return section.pointToNativePdf(page, point);
+    }
+    /**
+     * `In fills` array by correct values.
+     * @private
+     */
+    private initializePrimitive() : void {
+        this.array.clear();
+        this.array.add(new PdfReferenceHolder(this.pdfPage));
+        switch (this.destinationMode) {
+            case PdfDestinationMode.Location:
+                let simplePage : PdfPage = this.pdfPage as PdfPage;
+                let point : PointF = new PointF();
+                point = this.pointToNativePdf(simplePage, this.destinationLocation);
+                this.array.add(new PdfName(this.dictionaryProperties.xyz));
+                this.array.add(new PdfNumber(point.x));
+                this.array.add(new PdfNumber(point.y));
+                this.array.add(new PdfNumber(this.zoomFactor));
+                break;
+            case PdfDestinationMode.FitToPage:
+                this.array.add(new PdfName(this.dictionaryProperties.fit));
+                break;
+        }
+    }
+    /**
+     * Gets the `element` representing this object.
+     * @private
+     */
+    public get element() : IPdfPrimitive {
+        this.initializePrimitive();
+        return this.array;
+    }
+}