@syncfusion/ej2-pdf-export 25.2.3 → 26.2.4

package/dist/ts/implementation/pages/pdf-page-layer.ts

@@ -0,0 +1,271 @@
+/**
+ * PdfPageLayer.ts class for EJ2-PDF
+ */
+import { IPdfWrapper } from './../../interfaces/i-pdf-wrapper';
+import { IPdfPrimitive } from './../../interfaces/i-pdf-primitives';
+import { PdfPageBase } from './pdf-page-base';
+import { PdfStream } from './../primitives/pdf-stream';
+import { PdfDictionary } from './../primitives/pdf-dictionary';
+import { PdfGraphics, GetResourceEventHandler } from './../graphics/pdf-graphics';
+import { PdfPageLayerCollection } from './pdf-page-layer-collection';
+import { DictionaryProperties } from './../input-output/pdf-dictionary-properties';
+import { PdfArray } from './../primitives/pdf-array';
+import { PdfPage } from './pdf-page';
+import { RectangleF } from './../drawing/pdf-drawing';
+import { PdfSectionCollection } from './../pages/pdf-section-collection';
+import { PdfColorSpace } from './../graphics/enum';
+import { PdfMargins } from './../graphics/pdf-margins';
+/**
+ * The `PdfPageLayer` used to create layers in PDF document.
+ * @private
+ */
+export class PdfPageLayer implements IPdfWrapper {
+    // Fields
+    /**
+     * Parent `page` of the layer.
+     * @private
+     */
+    private pdfPage : PdfPageBase;
+    /**
+     * `Graphics context` of the layer.
+     * @private
+     */
+    private pdfGraphics : PdfGraphics;
+    /**
+     * `Content` of the object.
+     * @private
+     */
+    private content : PdfStream;
+    /**
+     * Indicates whether the layer should `clip page template` dimensions or not.
+     * @private
+     */
+    private clipPageTemplates : boolean;
+    // private bSaved : boolean;
+    /**
+     * Local Variable to store the `color space` of the document.
+     * @private
+     */
+    private pdfColorSpace : PdfColorSpace = PdfColorSpace.Rgb;
+    /**
+     * Local Variable to store the `layer id`.
+     * @private
+     */
+    private layerid : string;
+    /**
+     * Local Variable to store the `name`.
+     * @private
+     */
+    private layerName : string;
+    /**
+     * Local Variable to set `visibility`.
+     * @default true
+     * @private
+     */
+    private isVisible : boolean = true;
+    /**
+     * Collection of the `layers` of the page.
+     * @private
+     */
+    private layer : PdfPageLayerCollection;
+    /**
+     * Indicates if `Sublayer` is present.
+     * @default false
+     * @private
+     */
+    public sublayer : boolean = false;
+    /**
+     * Local variable to store `length` of the graphics.
+     * @default 0
+     * @private
+     */
+    public contentLength : number = 0;
+    /**
+     * Stores the `print Option` dictionary.
+     * @private
+     */
+    public printOption : PdfDictionary;
+    /**
+     * Stores the `usage` dictionary.
+     * @private
+     */
+    public usage : PdfDictionary;
+    /**
+     * Instance for `PdfDictionaryProperties` Class.
+     * @private
+     */
+    private dictionaryProperties : DictionaryProperties = new DictionaryProperties();
+    // Properties
+    /**
+     * Get or set the `color space`.
+     * @private
+     */
+    public get colorSpace() : PdfColorSpace {
+        return this.pdfColorSpace;
+    }
+    public set colorSpace(value : PdfColorSpace) {
+        this.pdfColorSpace = value;
+    }
+    /**
+     * Gets parent `page` of the layer.
+     * @private
+     */
+    public get page() : PdfPageBase {
+        return this.pdfPage;
+    }
+    /**
+     * Gets and Sets the `id of the layer`.
+     * @private
+     */
+    public get layerId() : string {
+        return this.layerid;
+    }
+    public set layerId(value : string) {
+        this.layerid = value;
+    }
+    /**
+     * Gets or sets the `name` of the layer.
+     * @private
+     */
+    public get name() : string {
+        return this.layerName;
+    }
+    public set name(value : string) {
+        this.layerName = value;
+    }
+    /**
+     * Gets or sets the `visibility` of the layer.
+     * @private
+     */
+    public get visible() : boolean {
+        return this.isVisible;
+    }
+    public set visible(value : boolean) {
+        this.isVisible = value;
+    }
+    /**
+     * Gets `Graphics` context of the layer, used to draw various graphical content on layer.
+     * @private
+     */
+    public get graphics() : PdfGraphics {
+        if ((this.pdfGraphics == null)) {
+            this.initializeGraphics(this.page);
+        }
+        return this.pdfGraphics;
+    }
+    /**
+     * Gets the collection of `PdfPageLayer`, this collection handle by the class 'PdfPageLayerCollection'.
+     * @private
+     */
+    public get layers() : PdfPageLayerCollection {
+        if (this.layer == null) {
+            this.layer = new PdfPageLayerCollection(this.page);
+            this.layer.sublayer  = true;
+            return this.layer;
+        } else {
+            return this.layer;
+        }
+    }
+    // Constructors
+    /**
+     * Initializes a new instance of the `PdfPageLayer` class with specified PDF page.
+     * @private
+     */
+    public constructor(page : PdfPageBase)
+    /**
+     * Initializes a new instance of the `PdfPageLayer` class with specified PDF page and PDF stream.
+     * @private
+     */
+    public constructor(page : PdfPageBase, stream : PdfStream)
+    /**
+     * Initializes a new instance of the `PdfPageLayer` class.
+     * @private
+     */
+    public constructor(page : PdfPageBase, clipPageTemplates : boolean)
+    public constructor(page : PdfPageBase, streamClipPageTemplates ?: boolean|PdfStream) {
+        if (page === null) {
+            throw new Error('ArgumentNullException:page');
+        }
+        this.pdfPage = page;
+        this.clipPageTemplates = true;
+        if (typeof streamClipPageTemplates === 'undefined') {
+             this.content = new PdfStream();
+        } else if (streamClipPageTemplates instanceof PdfStream || streamClipPageTemplates === null) {
+            if (streamClipPageTemplates === null) {
+                throw new Error('ArgumentNullException:stream');
+            }
+            this.content = streamClipPageTemplates as PdfStream;
+        } else {
+            this.content = new PdfStream();
+            this.clipPageTemplates = streamClipPageTemplates;
+        }
+    }
+    // Implementation
+    /**
+     * `Adds` a new PDF Page layer.
+     * @private
+     */
+    public add() : PdfPageLayer {
+        let layer : PdfPageLayer = new PdfPageLayer(this.pdfPage);
+        layer.name = '';
+        return layer;
+    }
+    /**
+     * Returns a value indicating the `sign` of a single-precision floating-point number.
+     * @private
+     */
+    private sign(number : number) : number {
+        if (number === 0) {
+            return 0;
+        } else if (number > 0) {
+            return 1;
+        } else {
+            return -1;
+        }
+    }
+    /**
+     * `Initializes Graphics context` of the layer.
+     * @private
+     */
+    private initializeGraphics(page : PdfPageBase) : void {
+        let oPage : PdfPage = page as PdfPage;
+        let gr : GetResourceEventHandler = new GetResourceEventHandler(this.page);
+        let cropBox : PdfArray = null;
+        this.pdfGraphics = new PdfGraphics(page.size, gr, this.content);
+        this.pdfGraphics.mediaBoxUpperRightBound = 0;
+        if (oPage != null) {
+            let sc : PdfSectionCollection = oPage.section.parent;
+            if (sc != null) {
+                this.pdfGraphics.colorSpace = sc.document.colorSpace;
+                this.colorSpace = sc.document.colorSpace;
+            }
+        }
+        // Transform coordinates to the left/top and activate margins.
+        let isSame : boolean = (this.sign(page.origin.y) === this.sign(page.origin.x));
+        // if (page != null) {
+        if (page.origin.x >= 0 && page.origin.y >= 0 || !(isSame)) {
+            this.pdfGraphics.initializeCoordinates();
+        } else {
+            // this.m_graphics.InitializeCoordinates(page);
+        }
+        let clipRect : RectangleF = oPage.section.getActualBounds(oPage, true);
+        let margins : PdfMargins = oPage.section.pageSettings.margins;
+        if (this.clipPageTemplates) {
+            if (page.origin.x >= 0 && page.origin.y >= 0) {
+                this.pdfGraphics.clipTranslateMargins(clipRect);
+            }
+        } else {
+            this.graphics.clipTranslateMargins(clipRect.x, clipRect.y, margins.left, margins.top, margins.right, margins.bottom);
+        }
+        this.pdfGraphics.setLayer(this);
+        // this.bSaved = false;
+    }
+    // IPdfWrapper Members
+    /**
+     * Gets the wrapped `element`.
+     * @private
+     */
+    public get element() : IPdfPrimitive {
+        return this.content;
+    }
+}

package/dist/ts/implementation/pages/pdf-page-settings.d.ts

@@ -0,0 +1,111 @@
+/**
+ * PdfPageSettings.ts class for EJ2-PDF
+ */
+import { SizeF, PointF } from './../drawing/pdf-drawing';
+import { PdfPageRotateAngle, PdfPageOrientation } from './enum';
+import { PdfMargins } from './../graphics/pdf-margins';
+/**
+ * The class provides various `setting` related with PDF pages.
+ */
+export declare class PdfPageSettings {
+    /**
+     * The page `margins`.
+     * @private
+     */
+    private pageMargins;
+    /**
+     * The page `size`.
+     * @default a4
+     * @private
+     */
+    private pageSize;
+    /**
+     * The page `rotation angle`.
+     * @default PdfPageRotateAngle.RotateAngle0
+     * @private
+     */
+    private rotateAngle;
+    /**
+     * The page `orientation`.
+     * @default PdfPageOrientation.Portrait
+     * @private
+     */
+    private pageOrientation;
+    /**
+     * The page `origin`.
+     * @default 0,0
+     * @private
+     */
+    private pageOrigin;
+    /**
+     * Checks the Whether the `rotation` is applied or not.
+     * @default false
+     * @private
+     */
+    isRotation: boolean;
+    /**
+     * Initializes a new instance of the `PdfPageSettings` class.
+     * @private
+     */
+    constructor();
+    /**
+     * Initializes a new instance of the `PdfPageSettings` class.
+     * @private
+     */
+    constructor(margins: number);
+    /**
+     * Gets or sets the `size` of the page.
+     * @private
+     */
+    size: SizeF;
+    /**
+     * Gets or sets the page `orientation`.
+     * @private
+     */
+    orientation: PdfPageOrientation;
+    /**
+     * Gets or sets the `margins` of the page.
+     * @private
+     */
+    margins: PdfMargins;
+    /**
+     * Gets or sets the `width` of the page.
+     * @private
+     */
+    width: number;
+    /**
+     * Gets or sets the `height` of the page.
+     * @private
+     */
+    height: number;
+    /**
+     * Gets or sets the `origin` of the page.
+     * @private
+     */
+    origin: PointF;
+    /**
+     * Gets or sets the number of degrees by which the page should be `rotated` clockwise when displayed or printed.
+     * @private
+     */
+    rotate: PdfPageRotateAngle;
+    /**
+     * `Update page size` depending on orientation.
+     * @private
+     */
+    private updateSize;
+    /**
+     * Creates a `clone` of the object.
+     * @private
+     */
+    clone(): PdfPageSettings;
+    /**
+     * Returns `size`, shrinked by the margins.
+     * @private
+     */
+    getActualSize(): SizeF;
+    /**
+     * Sets `size` to the page aaccording to the orientation.
+     * @private
+     */
+    private setSize;
+}

package/dist/ts/implementation/pages/pdf-page-settings.ts

@@ -0,0 +1,192 @@
+/**
+ * PdfPageSettings.ts class for EJ2-PDF
+ */
+import { SizeF, PointF } from './../drawing/pdf-drawing';
+import { PdfPageSize } from './pdf-page-size';
+import { PdfPageRotateAngle, PdfPageOrientation } from './enum';
+import { PdfMargins } from './../graphics/pdf-margins';
+/**
+ * The class provides various `setting` related with PDF pages.
+ */
+export class PdfPageSettings {
+    //Fields
+    /**
+     * The page `margins`.
+     * @private
+     */
+    private pageMargins : PdfMargins = new PdfMargins();
+    /**
+     * The page `size`.
+     * @default a4
+     * @private
+     */
+    private pageSize : SizeF = PdfPageSize.a4;
+    /**
+     * The page `rotation angle`.
+     * @default PdfPageRotateAngle.RotateAngle0
+     * @private
+     */
+    private rotateAngle : PdfPageRotateAngle = PdfPageRotateAngle.RotateAngle0;
+    /**
+     * The page `orientation`.
+     * @default PdfPageOrientation.Portrait
+     * @private
+     */
+    private pageOrientation : PdfPageOrientation = PdfPageOrientation.Portrait;
+    /**
+     * The page `origin`.
+     * @default 0,0
+     * @private
+     */
+    private pageOrigin : PointF = new PointF(0, 0);
+    /**
+     * Checks the Whether the `rotation` is applied or not.
+     * @default false
+     * @private
+     */
+    public isRotation : boolean = false;
+    //constructor
+    /**
+     * Initializes a new instance of the `PdfPageSettings` class.
+     * @private
+     */
+    constructor()
+    /**
+     * Initializes a new instance of the `PdfPageSettings` class.
+     * @private
+     */
+    constructor(margins : number)
+    constructor(margins? : number) {
+        if (typeof margins === 'number') {
+            this.pageMargins.setMargins(margins);
+        }
+    }
+    //Properties
+    /**
+     * Gets or sets the `size` of the page.
+     * @private
+     */
+    public get size() : SizeF {
+        return this.pageSize;
+    }
+    public set size(value : SizeF) {
+        this.setSize(value);
+    }
+    /**
+     * Gets or sets the page `orientation`.
+     * @private
+     */
+    public get orientation() : PdfPageOrientation {
+        return this.pageOrientation;
+    }
+    public set orientation(orientation : PdfPageOrientation) {
+        if (this.pageOrientation !== orientation) {
+            this.pageOrientation = orientation;
+            this.updateSize(orientation);
+        }
+    }
+    /**
+     * Gets or sets the `margins` of the page.
+     * @private
+     */
+    public get margins() : PdfMargins {
+        return this.pageMargins;
+    }
+    public set margins(value : PdfMargins) {
+        this.pageMargins = value;
+    }
+    /**
+     * Gets or sets the `width` of the page.
+     * @private
+     */
+    public get width() : number {
+        return this.pageSize.width;
+    }
+    public set width(value : number) {
+        this.pageSize.width = value;
+    }
+    /**
+     * Gets or sets the `height` of the page.
+     * @private
+     */
+    public get height() : number {
+        return this.pageSize.height;
+    }
+    public set height(value : number) {
+        this.pageSize.height = value;
+    }
+    /**
+     * Gets or sets the `origin` of the page.
+     * @private
+     */
+    public get origin() : PointF {
+        return this.pageOrigin;
+    }
+    public set origin(value : PointF) {
+        this.pageOrigin = value;
+    }
+    /**
+     * Gets or sets the number of degrees by which the page should be `rotated` clockwise when displayed or printed.
+     * @private
+     */
+    public get rotate() : PdfPageRotateAngle {
+        return this.rotateAngle;
+    }
+    public set rotate(value : PdfPageRotateAngle) {
+        this.rotateAngle = value;
+        this.isRotation = true;
+    }
+    //Methods
+    /**
+     * `Update page size` depending on orientation.
+     * @private
+     */
+    private updateSize(orientation : PdfPageOrientation) : void {
+        let min : number = Math.min(this.pageSize.width, this.pageSize.height);
+        let max : number = Math.max(this.pageSize.width, this.pageSize.height);
+        switch (orientation) {
+            case PdfPageOrientation.Portrait :
+                this.pageSize = new SizeF(min, max);
+                break;
+            case PdfPageOrientation.Landscape :
+                this.pageSize = new SizeF(max, min);
+                break;
+        }
+    }
+    /**
+     * Creates a `clone` of the object.
+     * @private
+     */
+    public clone() : PdfPageSettings {
+        let settings : PdfPageSettings = this;
+        settings.pageMargins = this.pageMargins.clone();
+        // if (GetTransition() != null)
+        // {
+        //     settings.Transition = (PdfPageTransition)Transition.clone();
+        // }
+        return settings;
+    }
+    /**
+     * Returns `size`, shrinked by the margins.
+     * @private
+     */
+    public getActualSize() : SizeF {
+        let width : number = this.width - (this.margins.left + this.margins.right);
+        let height : number = this.height - (this.margins.top + this.margins.bottom);
+        let size : SizeF = new SizeF(width, height);
+        return size;
+    }
+    /**
+     * Sets `size` to the page aaccording to the orientation.
+     * @private
+     */
+    private setSize(size : SizeF) : void {
+        let min : number = Math.min(size.width, size.height);
+        let max : number = Math.max(size.width, size.height);
+        if (this.orientation === PdfPageOrientation.Portrait) {
+            this.pageSize = new SizeF(min, max);
+        } else {
+            this.pageSize = new SizeF(max, min);
+        }
+    }
+}