@syncfusion/ej2-pdf-export 29.2.4 → 30.1.37

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.d.ts

@@ -0,0 +1,26 @@
+/**
+ * PdfCollection.ts class for EJ2-PDF
+ * The class used to handle the collection of PdF objects.
+ */
+export declare class PdfCollection {
+    /**
+     * Stores the `objects` as array.
+     * @private
+     */
+    private collection;
+    /**
+     * Initializes a new instance of the `Collection` class.
+     * @private
+     */
+    constructor();
+    /**
+     * Gets the `Count` of stored objects.
+     * @private
+     */
+    readonly count: number;
+    /**
+     * Gets the `list` of stored objects.
+     * @private
+     */
+    readonly list: Object[];
+}

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.d.ts

@@ -0,0 +1,103 @@
+/**
+ * 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 { PdfDestinationMode } from './../general/enum';
+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 declare class PdfDestination implements IPdfWrapper {
+    /**
+     * Internal variable for accessing fields from `DictionryProperties` class.
+     * @private
+     */
+    protected dictionaryProperties: DictionaryProperties;
+    /**
+     * Type of the `destination`.
+     * @private
+     */
+    private destinationMode;
+    /**
+     * `Zoom` factor.
+     * @private
+     * @default 0
+     */
+    private zoomFactor;
+    /**
+     * `Location` of the destination.
+     * @default new PointF() with 0 ,0 as co-ordinates
+     * @private
+     */
+    private destinationLocation;
+    /**
+     * `Bounds` of the destination as RectangleF.
+     * @default RectangleF.Empty
+     * @private
+     */
+    private bounds;
+    /**
+     * Parent `page` reference.
+     * @private
+     */
+    private pdfPage;
+    /**
+     * Pdf primitive representing `this` object.
+     * @private
+     */
+    private array;
+    /**
+     * Initializes a new instance of the `PdfDestination` class with page object.
+     * @private
+     */
+    constructor(page: PdfPageBase);
+    /**
+     * Initializes a new instance of the `PdfDestination` class with page object and location.
+     * @private
+     */
+    constructor(page: PdfPageBase, location: PointF);
+    /**
+     * Initializes a new instance of the `PdfDestination` class with page object and bounds.
+     * @private
+     */
+    constructor(page: PdfPageBase, rectangle: RectangleF);
+    /**
+     * Gets and Sets the `zoom` factor.
+     * @private
+     */
+    zoom: number;
+    /**
+     * Gets and Sets the `page` object.
+     * @private
+     */
+    page: PdfPageBase;
+    /**
+     * Gets and Sets the destination `mode`.
+     * @private
+     */
+    mode: PdfDestinationMode;
+    /**
+     * Gets and Sets the `location`.
+     * @private
+     */
+    location: PointF;
+    /**
+     * `Translates` co-ordinates to PDF co-ordinate system (lower/left).
+     * @private
+     */
+    private pointToNativePdf;
+    /**
+     * `In fills` array by correct values.
+     * @private
+     */
+    private initializePrimitive;
+    /**
+     * Gets the `element` representing this object.
+     * @private
+     */
+    readonly element: IPdfPrimitive;
+}

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;
+    }
+}

package/dist/ts/implementation/graphics/brushes/enum.d.ts

@@ -0,0 +1,236 @@
+/**
+ * Specifies the constant values specifying whether to extend the shading
+ * beyond the starting and ending points of the axis.
+ */
+export declare enum PdfExtend {
+    /**
+     * Do not extend any point.
+     */
+    None = 0,
+    /**
+     * Extend start point.
+     */
+    Start = 1,
+    /**
+     * Extend end point.
+     */
+    End = 2,
+    /**
+     * Extend both start and end points.
+     */
+    Both = 3
+}
+/**
+ * Specifies the gradient direction of the linear gradient brush.
+ */
+export declare enum PdfLinearGradientMode {
+    /**
+     * Specifies a gradient from upper right to lower left.
+     */
+    BackwardDiagonal = 0,
+    /**
+     * Specifies a gradient from upper left to lower right.
+     */
+    ForwardDiagonal = 1,
+    /**
+     * Specifies a gradient from left to right.
+     */
+    Horizontal = 2,
+    /**
+     * Specifies a gradient from top to bottom.
+     */
+    Vertical = 3
+}
+/**
+ * Shading type constants.
+ */
+export declare enum ShadingType {
+    /**
+     * Function-based shading.
+     */
+    Function = 1,
+    /**
+     * Axial shading.
+     */
+    Axial = 2,
+    /**
+     * Radial shading.
+     */
+    Radial = 3
+}
+export declare enum KnownColor {
+    ActiveBorder = 1,
+    ActiveCaption = 2,
+    ActiveCaptionText = 3,
+    AppWorkspace = 4,
+    Control = 5,
+    ControlDark = 6,
+    ControlDarkDark = 7,
+    ControlLight = 8,
+    ControlLightLight = 9,
+    ControlText = 10,
+    Desktop = 11,
+    GrayText = 12,
+    Highlight = 13,
+    HighlightText = 14,
+    HotTrack = 15,
+    InactiveBorder = 16,
+    InactiveCaption = 17,
+    InactiveCaptionText = 18,
+    Info = 19,
+    InfoText = 20,
+    Menu = 21,
+    MenuText = 22,
+    ScrollBar = 23,
+    Window = 24,
+    WindowFrame = 25,
+    WindowText = 26,
+    Transparent = 27,
+    AliceBlue = 28,
+    AntiqueWhite = 29,
+    Aqua = 30,
+    Aquamarine = 31,
+    Azure = 32,
+    Beige = 33,
+    Bisque = 34,
+    Black = 35,
+    BlanchedAlmond = 36,
+    Blue = 37,
+    BlueViolet = 38,
+    Brown = 39,
+    BurlyWood = 40,
+    CadetBlue = 41,
+    Chartreuse = 42,
+    Chocolate = 43,
+    Coral = 44,
+    CornflowerBlue = 45,
+    Cornsilk = 46,
+    Crimson = 47,
+    Cyan = 48,
+    DarkBlue = 49,
+    DarkCyan = 50,
+    DarkGoldenrod = 51,
+    DarkGray = 52,
+    DarkGreen = 53,
+    DarkKhaki = 54,
+    DarkMagenta = 55,
+    DarkOliveGreen = 56,
+    DarkOrange = 57,
+    DarkOrchid = 58,
+    DarkRed = 59,
+    DarkSalmon = 60,
+    DarkSeaGreen = 61,
+    DarkSlateBlue = 62,
+    DarkSlateGray = 63,
+    DarkTurquoise = 64,
+    DarkViolet = 65,
+    DeepPink = 66,
+    DeepSkyBlue = 67,
+    DimGray = 68,
+    DodgerBlue = 69,
+    Firebrick = 70,
+    FloralWhite = 71,
+    ForestGreen = 72,
+    Fuchsia = 73,
+    Gainsboro = 74,
+    GhostWhite = 75,
+    Gold = 76,
+    Goldenrod = 77,
+    Gray = 78,
+    Green = 79,
+    GreenYellow = 80,
+    Honeydew = 81,
+    HotPink = 82,
+    IndianRed = 83,
+    Indigo = 84,
+    Ivory = 85,
+    Khaki = 86,
+    Lavender = 87,
+    LavenderBlush = 88,
+    LawnGreen = 89,
+    LemonChiffon = 90,
+    LightBlue = 91,
+    LightCoral = 92,
+    LightCyan = 93,
+    LightGoldenrodYellow = 94,
+    LightGray = 95,
+    LightGreen = 96,
+    LightPink = 97,
+    LightSalmon = 98,
+    LightSeaGreen = 99,
+    LightSkyBlue = 100,
+    LightSlateGray = 101,
+    LightSteelBlue = 102,
+    LightYellow = 103,
+    Lime = 104,
+    LimeGreen = 105,
+    Linen = 106,
+    Magenta = 107,
+    Maroon = 108,
+    MediumAquamarine = 109,
+    MediumBlue = 110,
+    MediumOrchid = 111,
+    MediumPurple = 112,
+    MediumSeaGreen = 113,
+    MediumSlateBlue = 114,
+    MediumSpringGreen = 115,
+    MediumTurquoise = 116,
+    MediumVioletRed = 117,
+    MidnightBlue = 118,
+    MintCream = 119,
+    MistyRose = 120,
+    Moccasin = 121,
+    NavajoWhite = 122,
+    Navy = 123,
+    OldLace = 124,
+    Olive = 125,
+    OliveDrab = 126,
+    Orange = 127,
+    OrangeRed = 128,
+    Orchid = 129,
+    PaleGoldenrod = 130,
+    PaleGreen = 131,
+    PaleTurquoise = 132,
+    PaleVioletRed = 133,
+    PapayaWhip = 134,
+    PeachPuff = 135,
+    Peru = 136,
+    Pink = 137,
+    Plum = 138,
+    PowderBlue = 139,
+    Purple = 140,
+    Red = 141,
+    RosyBrown = 142,
+    RoyalBlue = 143,
+    SaddleBrown = 144,
+    Salmon = 145,
+    SandyBrown = 146,
+    SeaGreen = 147,
+    SeaShell = 148,
+    Sienna = 149,
+    Silver = 150,
+    SkyBlue = 151,
+    SlateBlue = 152,
+    SlateGray = 153,
+    Snow = 154,
+    SpringGreen = 155,
+    SteelBlue = 156,
+    Tan = 157,
+    Teal = 158,
+    Thistle = 159,
+    Tomato = 160,
+    Turquoise = 161,
+    Violet = 162,
+    Wheat = 163,
+    White = 164,
+    WhiteSmoke = 165,
+    Yellow = 166,
+    YellowGreen = 167,
+    ButtonFace = 168,
+    ButtonHighlight = 169,
+    ButtonShadow = 170,
+    GradientActiveCaption = 171,
+    GradientInactiveCaption = 172,
+    MenuBar = 173,
+    MenuHighlight = 174
+}