@syncfusion/ej2-pdf-export 29.1.41 → 30.1.37

package/dist/ts/implementation/graphics/figures/pdf-template.d.ts

@@ -0,0 +1,113 @@
+/**
+ * PdfTemplate.ts class for EJ2-PDF
+ */
+import { PdfStream } from './../../primitives/pdf-stream';
+import { PdfGraphics } from './../pdf-graphics';
+import { PdfResources } from './../pdf-resources';
+import { SizeF } from './../../drawing/pdf-drawing';
+import { IPdfWrapper } from './../../../interfaces/i-pdf-wrapper';
+import { IPdfPrimitive } from './../../../interfaces/i-pdf-primitives';
+/**
+ * Represents `Pdf Template` object.
+ * @private
+ */
+export declare class PdfTemplate implements IPdfWrapper {
+    /**
+     * Stores the value of current `graphics`.
+     * @private
+     */
+    private pdfGraphics;
+    /**
+     * Stores the instance of `PdfResources` class.
+     * @private
+     */
+    private resources;
+    /**
+     * Stores the `size` of the 'PdfTemplate'.
+     * @private
+     */
+    private templateSize;
+    /**
+     * Initialize an instance for `DictionaryProperties` class.
+     * @private
+     * @hidden
+     */
+    private dictionaryProperties;
+    /**
+     * Stores the `content` of the 'PdfTemplate'.
+     * @private
+     */
+    content: PdfStream;
+    /**
+     * Checks whether the transformation 'is performed'.
+     * @default true
+     * @private
+     */
+    writeTransformation: boolean;
+    /**
+     * Gets the size of the 'PdfTemplate'.
+     */
+    readonly size: SizeF;
+    /**
+     * Gets the width of the 'PdfTemplate'.
+     */
+    readonly width: number;
+    /**
+     * Gets the height of the 'PdfTemplate'.
+     */
+    readonly height: number;
+    /**
+     * Gets the `graphics` of the 'PdfTemplate'.
+     */
+    readonly graphics: PdfGraphics;
+    /**
+     * Gets the resources and modifies the template dictionary.
+     * @private
+     */
+    getResources(): PdfResources;
+    /**
+     * Create the new instance for `PdfTemplate` class.
+     * @private
+     */
+    constructor();
+    /**
+     * Create the new instance for `PdfTemplate` class with Size.
+     * @private
+     */
+    constructor(arg1: SizeF);
+    /**
+     * Create the new instance for `PdfTemplate` class with width and height.
+     * @private
+     */
+    constructor(arg1: number, arg2: number);
+    /**
+     * `Initialize` the type and subtype of the template.
+     * @private
+     */
+    private initialize;
+    /**
+     * `Adds type key`.
+     * @private
+     */
+    private addType;
+    /**
+     * `Adds SubType key`.
+     * @private
+     */
+    private addSubType;
+    /**
+     * `Reset` the size of the 'PdfTemplate'.
+     */
+    reset(): void;
+    reset(size: SizeF): void;
+    /**
+     * `Set the size` of the 'PdfTemplate'.
+     * @private
+     */
+    private setSize;
+    /**
+     * Gets the `content stream` of 'PdfTemplate' class.
+     * @private
+     */
+    readonly element: IPdfPrimitive;
+}

package/dist/ts/implementation/graphics/figures/pdf-template.ts

@@ -0,0 +1,205 @@
+/**
+ * PdfTemplate.ts class for EJ2-PDF
+ */
+import { PdfStream } from './../../primitives/pdf-stream';
+import { DictionaryProperties } from './../../input-output/pdf-dictionary-properties';
+import { PdfArray } from './../../primitives/pdf-array';
+import { PdfGraphics } from './../pdf-graphics';
+import { PdfStreamWriter } from './../../input-output/pdf-stream-writer';
+import { PdfResources } from './../pdf-resources';
+import { PdfName } from './../../primitives/pdf-name';
+import { PointF, SizeF, RectangleF } from './../../drawing/pdf-drawing';
+import { IPdfWrapper } from './../../../interfaces/i-pdf-wrapper';
+import { IPdfPrimitive } from './../../../interfaces/i-pdf-primitives';
+import { GetResourceEventHandler } from './../pdf-graphics';
+/**
+ * Represents `Pdf Template` object.
+ * @private
+ */
+export class PdfTemplate implements IPdfWrapper {
+    //Fields
+    /**
+     * Stores the value of current `graphics`.
+     * @private
+     */
+    private pdfGraphics : PdfGraphics;
+    /**
+     * Stores the instance of `PdfResources` class.
+     * @private
+     */
+    private resources : PdfResources;
+    /**
+     * Stores the `size` of the 'PdfTemplate'.
+     * @private
+     */
+    private templateSize : SizeF;
+    /**
+     * Initialize an instance for `DictionaryProperties` class.
+     * @private
+     * @hidden
+     */
+    private dictionaryProperties : DictionaryProperties = new DictionaryProperties();
+    /**
+     * Stores the `content` of the 'PdfTemplate'.
+     * @private
+     */
+    public content : PdfStream;
+    /**
+     * Checks whether the transformation 'is performed'.
+     * @default true
+     * @private
+     */
+    public writeTransformation : boolean = true;
+    //Properties
+    /**
+     * Gets the size of the 'PdfTemplate'.
+     */
+    public get size() : SizeF {
+        return this.templateSize;
+    }
+    /**
+     * Gets the width of the 'PdfTemplate'.
+     */
+    public get width() : number {
+        return this.size.width;
+    }
+    /**
+     * Gets the height of the 'PdfTemplate'.
+     */
+    public get height() : number {
+        return this.size.height;
+    }
+    /**
+     * Gets the `graphics` of the 'PdfTemplate'.
+     */
+    public get graphics() : PdfGraphics {
+        if (this.pdfGraphics == null || typeof this.pdfGraphics === 'undefined') {
+            let gr : GetResourceEventHandler = new GetResourceEventHandler(this);
+            let g : PdfGraphics = new PdfGraphics(this.size, gr, this.content);
+            this.pdfGraphics = g;
+            // if(this.writeTransformation) {
+            // Transform co-ordinates to Top/Left.
+            this.pdfGraphics.initializeCoordinates();
+            // }
+        }
+        return this.pdfGraphics;
+    }
+    /**
+     * Gets the resources and modifies the template dictionary.
+     * @private
+     */
+    public getResources() : PdfResources {
+        if (this.resources == null) {
+            this.resources = new PdfResources();
+            this.content.items.setValue(this.dictionaryProperties.resources, this.resources);
+        }
+        return this.resources;
+    }
+    /**
+     * Create the new instance for `PdfTemplate` class.
+     * @private
+     */
+    public constructor()
+    /**
+     * Create the new instance for `PdfTemplate` class with Size.
+     * @private
+     */
+    public constructor(arg1 : SizeF)
+    /**
+     * Create the new instance for `PdfTemplate` class with width and height.
+     * @private
+     */
+    public constructor(arg1 : number, arg2 : number)
+    public constructor(arg1 ?: number | SizeF, arg2 ?: number) {
+        if (typeof arg1 === 'undefined') {
+            //
+        } else if (arg1 instanceof SizeF && typeof arg2 === 'undefined') {
+            this.content = new PdfStream();
+            let tempSize : SizeF = new SizeF(arg1.width, arg1.height);
+            this.setSize(tempSize);
+            this.initialize();
+        } else {
+            this.content = new PdfStream();
+            this.setSize(new SizeF(arg1 as number, arg2 as number));
+            this.initialize();
+        }
+    }
+    // Public methods
+    /**
+     * `Initialize` the type and subtype of the template.
+     * @private
+     */
+    private initialize() : void {
+        this.addType();
+        this.addSubType();
+    }
+    /**
+     * `Adds type key`.
+     * @private
+     */
+    private addType() : void {
+        let value : PdfName = new PdfName(this.dictionaryProperties.xObject);
+        this.content.items.setValue(this.dictionaryProperties.type, value);
+    }
+    /**
+     * `Adds SubType key`.
+     * @private
+     */
+    private addSubType() : void {
+        let value : PdfName = new PdfName(this.dictionaryProperties.form);
+        this.content.items.setValue(this.dictionaryProperties.subtype, value);
+    }
+    /**
+     * `Reset` the size of the 'PdfTemplate'.
+     */
+    public reset() : void
+    public reset(size : SizeF) : void
+    public reset(size ?: SizeF) : void {
+        if (typeof size === 'undefined') {
+            if (this.resources != null) {
+                this.resources = null;
+                this.content.remove(this.dictionaryProperties.resources);
+            }
+            if (this.graphics != null) {
+                this.graphics.reset(this.size);
+            }
+        } else {
+            this.setSize(size);
+            this.reset();
+        }
+    }
+    /**
+     * `Set the size` of the 'PdfTemplate'.
+     * @private
+     */
+    private setSize(size : SizeF) : void {
+        let rect : RectangleF = new RectangleF(new PointF(0, 0), size);
+        let val : PdfArray = PdfArray.fromRectangle(rect);
+        this.content.items.setValue(this.dictionaryProperties.bBox, val);
+        this.templateSize = size;
+    }
+    // /**
+    //  * Returns the value of current graphics.
+    //  * @private
+    //  */
+    // public GetGraphics(g : PdfGraphics) : PdfGraphics {
+    //     if (this.graphics == null || typeof this.graphics === 'undefined') {
+    //         this.graphics = g;
+    //         this.graphics.Size = this.Size;
+    //         this.graphics.StreamWriter = new PdfStreamWriter(this.content)
+    //         this.graphics.Initialize();
+    //         if(this.writeTransformation) {
+    //             this.graphics.InitializeCoordinates();
+    //         }
+    //     }
+    //     return this.graphics;
+    // }
+    // IPdfWrapper Members
+    /**
+     * Gets the `content stream` of 'PdfTemplate' class.
+     * @private
+     */
+    public get element() : IPdfPrimitive {
+        return this.content;
+    }
+}

package/dist/ts/implementation/graphics/figures/rectangle-area.d.ts

@@ -0,0 +1,64 @@
+/**
+ * RectangleArea.ts class for EJ2-PDF
+ */
+import { PdfBrush } from './../brushes/pdf-brush';
+import { PdfPen } from './../pdf-pen';
+import { RectangleF } from './../../drawing/pdf-drawing';
+import { PdfFillElement } from './../figures/base/fill-element';
+/**
+ * `PdfRectangleArea` class Implements graphics rectangle area, which is a sequence of primitive graphics elements.
+ * @private
+ */
+export declare abstract class PdfRectangleArea extends PdfFillElement {
+    /**
+     * public variable to store the rectangle.
+     * @public
+     */
+    bounds: RectangleF;
+    /**
+     * Initializes a new instance of the `PdfRectangleArea` class.
+     * @protected
+     */
+    protected constructor();
+    /**
+     * Initializes a new instance of the `PdfRectangleArea` class.
+     * @protected
+     */
+    protected constructor(rectangle: RectangleF);
+    /**
+     * Initializes a new instance of the `PdfRectangleArea` class.
+     * @protected
+     */
+    protected constructor(pen: PdfPen, brush: PdfBrush, rectangle: RectangleF);
+    /**
+     * Initializes a new instance of the `PdfRectangleArea` class.
+     * @protected
+     */
+    protected constructor(x: number, y: number, width: number, height: number);
+    /**
+     * Initializes a new instance of the `PdfRectangleArea` class.
+     * @protected
+     */
+    protected constructor(pen: PdfPen, brush: PdfBrush, x: number, y: number, width: number, height: number);
+    /**
+     * Gets or sets the X co-ordinate of the upper-left corner of this the element.
+     * @public
+     */
+    x: number;
+    /**
+     * Gets or sets the Y co-ordinate of the upper-left corner of this the element.
+     * @public
+     */
+    y: number;
+    /**
+     * Gets or sets the width of this element.
+     * @public
+     */
+    width: number;
+    /**
+     * Gets or sets the height of this element.
+     * @public
+     */
+    height: number;
+    protected getBoundsInternal(): RectangleF;
+}

package/dist/ts/implementation/graphics/figures/rectangle-area.ts

@@ -0,0 +1,108 @@
+/**
+ * RectangleArea.ts class for EJ2-PDF
+ */
+import { PdfBrush } from './../brushes/pdf-brush';
+import { PdfPen } from './../pdf-pen';
+import { RectangleF } from './../../drawing/pdf-drawing';
+import { PdfFillElement} from './../figures/base/fill-element';
+/**
+ * `PdfRectangleArea` class Implements graphics rectangle area, which is a sequence of primitive graphics elements.
+ * @private
+ */
+export abstract class PdfRectangleArea extends PdfFillElement {
+    //Fields
+    /**
+     * public variable to store the rectangle.
+     * @public
+     */
+    public bounds : RectangleF = new RectangleF( 0, 0, 0, 0);
+    //Constructor
+    /**
+     * Initializes a new instance of the `PdfRectangleArea` class.
+     * @protected
+     */
+    protected constructor ()
+    /**
+     * Initializes a new instance of the `PdfRectangleArea` class.
+     * @protected
+     */
+    protected constructor (rectangle: RectangleF)
+    /**
+     * Initializes a new instance of the `PdfRectangleArea` class.
+     * @protected
+     */
+    protected constructor (pen: PdfPen, brush: PdfBrush, rectangle: RectangleF)
+    /**
+     * Initializes a new instance of the `PdfRectangleArea` class.
+     * @protected
+     */
+    protected constructor (x: number, y: number, width: number, height: number)
+    /**
+     * Initializes a new instance of the `PdfRectangleArea` class.
+     * @protected
+     */
+    protected constructor (pen: PdfPen, brush: PdfBrush, x: number, y: number, width: number, height: number)
+    /* tslint:disable-next-line:max-line-length */
+    protected constructor (arg1?: PdfPen|number|RectangleF , arg2?: PdfBrush|number, arg3?: number|RectangleF, arg4?: number, arg5?: number, arg6?: number) {
+        super();
+        if (typeof arg1 === 'undefined') {
+            //
+        } else if (arg1 instanceof PdfPen) {
+            super(arg1, arg2 as PdfBrush);
+            if (arg3 instanceof RectangleF) {
+                this.bounds = arg3;
+            } else {
+                this.bounds = new RectangleF(arg3, arg4, arg5, arg6);
+            }
+        } else if (arg1 instanceof RectangleF) {
+            this.bounds = arg1;
+        } else {
+            this.bounds = new RectangleF(arg1 as number, arg2 as number, arg3 as number, arg4 as number);
+        }
+    }
+    //Properties
+    /**
+     * Gets or sets the X co-ordinate of the upper-left corner of this the element.
+     * @public
+     */
+    public get x(): number {
+        return this.bounds.x;
+    }
+    public set x(value: number) {
+        this.bounds.x = value;
+    }
+    /**
+     * Gets or sets the Y co-ordinate of the upper-left corner of this the element.
+     * @public
+     */
+    public get y(): number {
+        return this.bounds.y;
+    }
+    public set y(value: number) {
+        this.bounds.y = value;
+    }
+    /**
+     * Gets or sets the width of this element.
+     * @public
+     */
+    public get width(): number {
+        return this.bounds.width;
+    }
+    public set width(value: number) {
+        this.bounds.width = value;
+    }
+    /**
+     * Gets or sets the height of this element.
+     * @public
+     */
+    public get height(): number {
+        return this.bounds.height;
+    }
+    public set height(value: number) {
+        this.bounds.height = value;
+    }
+    //Implementation
+    protected getBoundsInternal(): RectangleF {
+        return this.bounds;
+    }
+}

package/dist/ts/implementation/graphics/figures/text-element.d.ts

@@ -0,0 +1,214 @@
+/**
+ * PdfTextElement.ts class for EJ2-PDF
+ */
+import { PdfLayoutElement } from './../figures/layout-element';
+import { PdfBrush } from './../brushes/pdf-brush';
+import { PdfFont } from './../fonts/pdf-font';
+import { PdfPen } from './../pdf-pen';
+import { PdfStringFormat } from './../fonts/pdf-string-format';
+import { PdfLayoutParams, PdfLayoutResult } from './../figures/base/element-layouter';
+import { RectangleF, PointF } from './../../drawing/pdf-drawing';
+import { PdfPage } from './../../pages/pdf-page';
+import { PdfLayoutFormat } from './base/element-layouter';
+/**
+ * `PdfTextElement` class represents the text area with the ability to span several pages
+ * and inherited from the 'PdfLayoutElement' class.
+ * @private
+ */
+export declare class PdfTextElement extends PdfLayoutElement {
+    /**
+     * `Text` data.
+     * @private
+     */
+    private content;
+    /**
+     * `Value` of text data.
+     * @private
+     */
+    private elementValue;
+    /**
+     * `Pen` for text drawing.
+     * @private
+     */
+    private pdfPen;
+    /**
+     * `Brush` for text drawing.
+     * @private
+     */
+    private pdfBrush;
+    /**
+     * `Font` for text drawing.
+     * @private
+     */
+    private pdfFont;
+    /**
+     * Text `format`.
+     * @private
+     */
+    private format;
+    /**
+     * indicate whether the drawText with PointF overload is called or not.
+     * @default false
+     * @private
+     */
+    private hasPointOverload;
+    _isLastElement: boolean;
+    /**
+     * indicate whether the PdfGridCell value is `PdfTextElement`
+     * @default false
+     * @private
+     */
+    isPdfTextElement: boolean;
+    /**
+     * Initializes a new instance of the `PdfTextElement` class.
+     * @private
+     */
+    constructor();
+    /**
+     * Initializes a new instance of the `PdfTextElement` class with text to draw into the PDF.
+     * @private
+     */
+    constructor(text: string);
+    /**
+     * Initializes a new instance of the `PdfTextElement` class with the text and `PdfFont`.
+     * @private
+     */
+    constructor(text: string, font: PdfFont);
+    /**
+     * Initializes a new instance of the `PdfTextElement` class with text,`PdfFont` and `PdfPen`.
+     * @private
+     */
+    constructor(text: string, font: PdfFont, pen: PdfPen);
+    /**
+     * Initializes a new instance of the `PdfTextElement` class with text,`PdfFont` and `PdfBrush`.
+     * @private
+     */
+    constructor(text: string, font: PdfFont, brush: PdfBrush);
+    /**
+     * Initializes a new instance of the `PdfTextElement` class with text,`PdfFont`,`PdfPen`,`PdfBrush` and `PdfStringFormat`.
+     * @private
+     */
+    constructor(text: string, font: PdfFont, pen: PdfPen, brush: PdfBrush, format: PdfStringFormat);
+    /**
+     * Gets or sets a value indicating the `text` that should be printed.
+     * ```typescript
+     * // create a new PDF document.
+     * let document : PdfDocument = new PdfDocument();
+     * // add a page to the document.
+     * let page1 : PdfPage = document.pages.add();
+     * // create the font
+     * let font : PdfFont = new PdfStandardFont(PdfFontFamily.Helvetica, 12);
+     * // create the Text Web Link
+     * let textLink : PdfTextWebLink = new PdfTextWebLink();
+     * // set the hyperlink
+     * textLink.url = 'http://www.google.com';
+     * //
+     * // set the link text
+     * textLink.text = 'Google';
+     * //
+     * // set the font
+     * textLink.font = font;
+     * // draw the hyperlink in PDF page
+     * textLink.draw(page1, new PointF(10, 40));
+     * // save the document.
+     * document.save('output.pdf');
+     * // destroy the document
+     * document.destroy();
+     * ```
+     */
+    text: string;
+    /**
+     * Gets or sets a `value` indicating the text that should be printed.
+     * @private
+     */
+    readonly value: string;
+    /**
+     * Gets or sets a `PdfPen` that determines the color, width, and style of the text
+     * @private
+     */
+    pen: PdfPen;
+    /**
+     * Gets or sets the `PdfBrush` that will be used to draw the text with color and texture.
+     * @private
+     */
+    brush: PdfBrush;
+    /**
+     * Gets or sets a `PdfFont` that defines the text format.
+     * ```typescript
+     * // create a new PDF document.
+     * let document : PdfDocument = new PdfDocument();
+     * // add a page to the document.
+     * let page1 : PdfPage = document.pages.add();
+     * // create the font
+     * let font : PdfFont = new PdfStandardFont(PdfFontFamily.Helvetica, 12);
+     * // create the Text Web Link
+     * let textLink : PdfTextWebLink = new PdfTextWebLink();
+     * // set the hyperlink
+     * textLink.url = 'http://www.google.com';
+     * // set the link text
+     * textLink.text = 'Google';
+     * //
+     * // set the font
+     * textLink.font = font;
+     * //
+     * // draw the hyperlink in PDF page
+     * textLink.draw(page1, new PointF(10, 40));
+     * // save the document.
+     * document.save('output.pdf');
+     * // destroy the document
+     * document.destroy();
+     * ```
+     */
+    font: PdfFont;
+    /**
+     * Gets or sets the `PdfStringFormat` that will be used to set the string format
+     * @private
+     */
+    stringFormat: PdfStringFormat;
+    /**
+     * Gets a `brush` for drawing.
+     * @private
+     */
+    getBrush(): PdfBrush;
+    /**
+     * `Layouts` the element.
+     * @private
+     */
+    protected layout(param: PdfLayoutParams): PdfLayoutResult;
+    /**
+     * `Draws` the element on the page with the specified page and "PointF" class
+     * @private
+     */
+    drawText(page: PdfPage, location: PointF): PdfLayoutResult;
+    /**
+     * `Draws` the element on the page with the specified page and pair of coordinates
+     * @private
+     */
+    drawText(page: PdfPage, x: number, y: number): PdfLayoutResult;
+    /**
+     * `Draws` the element on the page with the specified page and "RectangleF" class
+     * @private
+     */
+    drawText(page: PdfPage, layoutRectangle: RectangleF): PdfLayoutResult;
+    /**
+     * `Draws` the element on the page with the specified page, "PointF" class and layout format
+     * @private
+     */
+    drawText(page: PdfPage, location: PointF, format: PdfLayoutFormat): PdfLayoutResult;
+    /**
+     * `Draws` the element on the page with the specified page, pair of coordinates and layout format
+     * @private
+     */
+    drawText(page: PdfPage, x: number, y: number, format: PdfLayoutFormat): PdfLayoutResult;
+    /**
+     * `Draws` the element on the page.
+     * @private
+     */
+    drawText(page: PdfPage, layoutRectangle: RectangleF, embedFonts: boolean): PdfLayoutResult;
+    /**
+     * `Draws` the element on the page with the specified page, "RectangleF" class and layout format
+     * @private
+     */
+    drawText(page: PdfPage, layoutRectangle: RectangleF, format: PdfLayoutFormat): PdfLayoutResult;
+    private calculateResultBounds;
+}