@syncfusion/ej2-pdf-export 29.2.4 → 30.1.37

package/dist/ts/implementation/graphics/pdf-margins.d.ts

@@ -0,0 +1,82 @@
+/**
+ * PdfMargins.ts class for EJ2-PDF
+ * A class representing PDF page margins.
+ */
+export declare class PdfMargins {
+    /**
+     * Represents the `Left margin` value.
+     * @private
+     */
+    private leftMargin;
+    /**
+     * Represents the `Top margin` value.
+     * @private
+     */
+    private topMargin;
+    /**
+     * Represents the `Right margin` value.
+     * @private
+     */
+    private rightMargin;
+    /**
+     * Represents the `Bottom margin` value.
+     * @private
+     */
+    private bottomMargin;
+    /**
+     * Represents the `Default Page Margin` value.
+     * @default 0.0
+     * @private
+     */
+    private readonly pdfMargin;
+    /**
+     * Initializes a new instance of the `PdfMargins` class.
+     * @private
+     */
+    constructor();
+    /**
+     * Gets or sets the `left margin` size.
+     * @private
+     */
+    left: number;
+    /**
+     * Gets or sets the `top margin` size.
+     * @private
+     */
+    top: number;
+    /**
+     * Gets or sets the `right margin` size.
+     * @private
+     */
+    right: number;
+    /**
+     * Gets or sets the `bottom margin` size.
+     * @private
+     */
+    bottom: number;
+    /**
+     * Sets the `margins`.
+     * @private
+     */
+    all: number;
+    /**
+     * Sets the `margins`.
+     * @private
+     */
+    setMargins(margin1: number): void;
+    /**
+     * Sets the `margins`.
+     * @private
+     */
+    setMargins(margin1: number, margin2: number): void;
+    /**
+     * Sets the `margins`.
+     * @private
+     */
+    setMargins(margin1: number, margin2: number, margin3: number, margin4: number): void;
+    /**
+     * `Clones` the object.
+     * @private
+     */
+    clone(): PdfMargins;
+}

package/dist/ts/implementation/graphics/pdf-margins.ts

@@ -0,0 +1,124 @@
+/**
+ * PdfMargins.ts class for EJ2-PDF
+ * A class representing PDF page margins.
+ */
+export class PdfMargins {
+    /**
+     * Represents the `Left margin` value.
+     * @private
+     */
+    private leftMargin : number;
+    /**
+     * Represents the `Top margin` value.
+     * @private
+     */
+    private topMargin : number;
+    /**
+     * Represents the `Right margin` value.
+     * @private
+     */
+    private rightMargin : number;
+    /**
+     * Represents the `Bottom margin` value.
+     * @private
+     */
+    private bottomMargin : number;
+    /**
+     * Represents the `Default Page Margin` value.
+     * @default 0.0
+     * @private
+     */
+    private readonly pdfMargin : number = 40.0;
+    /**
+     * Initializes a new instance of the `PdfMargins` class.
+     * @private
+     */
+    constructor() {
+        this.setMargins(this.pdfMargin);
+    }
+    //Properties
+    /**
+     * Gets or sets the `left margin` size.
+     * @private
+     */
+    public get left() : number {
+        return this.leftMargin;
+    }
+    public set left(value : number) {
+        this.leftMargin = value;
+    }
+    /**
+     * Gets or sets the `top margin` size.
+     * @private
+     */
+    public get top() : number {
+        return this.topMargin;
+    }
+    public set top(value : number) {
+        this.topMargin = value;
+    }
+    /**
+     * Gets or sets the `right margin` size.
+     * @private
+     */
+    public get right() : number {
+        return this.rightMargin;
+    }
+    public set right(value : number) {
+        this.rightMargin = value;
+    }
+    /**
+     * Gets or sets the `bottom margin` size.
+     * @private
+     */
+    public get bottom() : number {
+        return this.bottomMargin;
+    }
+    public set bottom(value : number) {
+        this.bottomMargin = value;
+    }
+    /**
+     * Sets the `margins`.
+     * @private
+     */
+    public set all(value : number) {
+        this.setMargins(value);
+    }
+    /**
+     * Sets the `margins`.
+     * @private
+     */
+    public setMargins(margin1 : number) : void
+    /**
+     * Sets the `margins`.
+     * @private
+     */
+    public setMargins(margin1 : number, margin2 : number) : void
+    /**
+     * Sets the `margins`.
+     * @private
+     */
+    public setMargins(margin1 : number, margin2 : number, margin3 : number, margin4 : number) : void
+    public setMargins(margin1 : number, margin2? : number, margin3? : number, margin4? : number) : void {
+        if (typeof margin2 === 'undefined') {
+            this.leftMargin = this.topMargin = this.rightMargin = this.bottomMargin = margin1;
+        } else {
+            if (typeof margin3 === 'undefined') {
+                this.leftMargin = this.rightMargin = margin1;
+                this.bottomMargin = this.topMargin = margin2;
+            } else {
+                this.leftMargin = margin1;
+                this.topMargin = margin2;
+                this.rightMargin = margin3;
+                this.bottomMargin = margin4;
+            }
+        }
+    }
+    /**
+     * `Clones` the object.
+     * @private
+     */
+    public clone() : PdfMargins {
+        return this;
+    }
+}

package/dist/ts/implementation/graphics/pdf-pen.d.ts

@@ -0,0 +1,237 @@
+/**
+ * PdfPen.ts class for EJ2-PDF
+ */
+import { PdfColor } from './pdf-color';
+import { PdfDashStyle, PdfLineCap, PdfLineJoin, PdfColorSpace } from './enum';
+import { PdfBrush } from './brushes/pdf-brush';
+import { GetResourceEventHandler } from './pdf-graphics';
+import { PdfTransformationMatrix } from './pdf-transformation-matrix';
+import { PdfStreamWriter } from './../input-output/pdf-stream-writer';
+/**
+ * `PdfPen` class defining settings for drawing operations, that determines the color,
+ * width, and style of the drawing elements.
+ * ```typescript
+ * // create a new PDF document
+ * let document : PdfDocument = new PdfDocument();
+ * // create a new page
+ * let page1 : PdfPage = document.pages.add();
+ * // set pen
+ * let pen : PdfPen = new PdfPen(new PdfColor(0, 0, 0));
+ * // draw rectangle
+ * page1.graphics.drawRectangle(pen, new RectangleF({x : 0, y : 0}, {width : 100, height : 50}));
+ * // save the document.
+ * document.save('output.pdf');
+ * // destroy the document
+ * document.destroy();
+ * ```
+ */
+export declare class PdfPen {
+    /**
+     * Specifies the `color of the pen`.
+     * @default new PdfColor()
+     * @private
+     */
+    private pdfColor;
+    /**
+     * Specifies the `dash offset of the pen`.
+     * @default 0
+     * @private
+     */
+    private dashOffsetValue;
+    /**
+     * Specifies the `dash pattern of the pen`.
+     * @default [0]
+     * @private
+     */
+    private penDashPattern;
+    /**
+     * Specifies the `dash style of the pen`.
+     * @default Solid
+     * @private
+     */
+    private pdfDashStyle;
+    /**
+     * Specifies the `line cap of the pen`.
+     * @default 0
+     * @private
+     */
+    private pdfLineCap;
+    /**
+     * Specifies the `line join of the pen`.
+     * @default 0
+     * @private
+     */
+    private pdfLineJoin;
+    /**
+     * Specifies the `width of the pen`.
+     * @default 1.0
+     * @private
+     */
+    private penWidth;
+    /**
+     * Specifies the `brush of the pen`.
+     * @private
+     */
+    private pdfBrush;
+    /**
+     * Specifies the `mitter limit of the pen`.
+     * @default 0.0
+     * @private
+     */
+    private internalMiterLimit;
+    /**
+     * Stores the `colorspace` value.
+     * @default Rgb
+     * @private
+     */
+    private colorSpace;
+    /**
+     * Initializes a new instance of the `PdfPen` class with color.
+     * ```typescript
+     * // create a new PDF document
+     * let document : PdfDocument = new PdfDocument();
+     * // create a new page
+     * let page1 : PdfPage = document.pages.add();
+     * //
+     * // set pen
+     * let pen : PdfPen = new PdfPen(new PdfColor(0, 0, 0));
+     * //
+     * // draw rectangle
+     * page1.graphics.drawRectangle(pen, new RectangleF({x : 0, y : 0}, {width : 100, height : 50}));
+     * // save the document.
+     * document.save('output.pdf');
+     * // destroy the document
+     * document.destroy();
+     * ```
+     * @param color Color of the pen.
+     */
+    constructor(color: PdfColor);
+    /**
+     * Initializes a new instance of the `PdfPen` class with 'PdfBrush' class and width of the pen.
+     * @private
+     */
+    constructor(brush: PdfBrush, width: number);
+    /**
+     * Initializes a new instance of the `PdfPen` class with color and width of the pen.
+     * ```typescript
+     * // create a new PDF document
+     * let document : PdfDocument = new PdfDocument();
+     * // create a new page
+     * let page1 : PdfPage = document.pages.add();
+     * //
+     * // set pen
+     * let pen : PdfPen = new PdfPen(new PdfColor(0, 0, 0), 2);
+     * //
+     * // draw rectangle
+     * page1.graphics.drawRectangle(pen, new RectangleF({x : 0, y : 0}, {width : 100, height : 50}));
+     * // save the document.
+     * document.save('output.pdf');
+     * // destroy the document
+     * document.destroy();
+     * ```
+     * @param color Color of the pen.
+     * @param width Width of the pen's line.
+     */
+    constructor(color: PdfColor, width: number);
+    /**
+     * Gets or sets the `color of the pen`.
+     * @private
+     */
+    color: PdfColor;
+    /**
+     * Gets or sets the `dash offset of the pen`.
+     * @private
+     */
+    dashOffset: number;
+    /**
+     * Gets or sets the `dash pattern of the pen`.
+     * @private
+     */
+    dashPattern: number[];
+    /**
+     * Gets or sets the `dash style of the pen`.
+     * ```typescript
+     * // create a new PDF document
+     * let document : PdfDocument = new PdfDocument();
+     * // create a new page
+     * let page1 : PdfPage = document.pages.add();
+     * // set pen
+     * let pen : PdfPen = new PdfPen(new PdfColor(0, 0, 0));
+     * //
+     * // set pen style
+     * pen.dashStyle = PdfDashStyle.DashDot;
+     * // get pen style
+     * let style : PdfDashStyle = pen.dashStyle;
+     * //
+     * // draw rectangle
+     * page1.graphics.drawRectangle(pen, new RectangleF({x : 0, y : 0}, {width : 100, height : 50}));
+     * // save the document.
+     * document.save('output.pdf');
+     * // destroy the document
+     * document.destroy();
+     * ```
+     */
+    dashStyle: PdfDashStyle;
+    /**
+     * Gets or sets the `line cap of the pen`.
+     * @private
+     */
+    lineCap: PdfLineCap;
+    /**
+     * Gets or sets the `line join style of the pen`.
+     * @private
+     */
+    lineJoin: PdfLineJoin;
+    /**
+     * Gets or sets the `miter limit`.
+     * @private
+     */
+    miterLimit: number;
+    /**
+     * Gets or sets the `width of the pen`.
+     * ```typescript
+     * // create a new PDF document
+     * let document : PdfDocument = new PdfDocument();
+     * // create a new page
+     * let page1 : PdfPage = document.pages.add();
+     * // set pen
+     * let pen : PdfPen = new PdfPen(new PdfColor(0, 0, 0));
+     * //
+     * // set pen width
+     * pen.width = 2;
+     * //
+     * // draw rectangle
+     * page1.graphics.drawRectangle(pen, new RectangleF({x : 0, y : 0}, {width : 100, height : 50}));
+     * // save the document.
+     * document.save('output.pdf');
+     * // destroy the document
+     * document.destroy();
+     * ```
+     */
+    width: number;
+    /**
+     * `Clones` this instance of PdfPen class.
+     * @private
+     */
+    clone(): PdfPen;
+    /**
+     * `Sets the brush`.
+     * @private
+     */
+    private setBrush;
+    /**
+     * `Monitors the changes`.
+     * @private
+     */
+    monitorChanges(currentPen: PdfPen, streamWriter: PdfStreamWriter, getResources: GetResourceEventHandler, saveState: boolean, currentColorSpace: PdfColorSpace, matrix: PdfTransformationMatrix): boolean;
+    /**
+     * `Controls the dash style` and behaviour of each line.
+     * @private
+     */
+    private dashControl;
+    /**
+     * `Gets the pattern` of PdfPen.
+     * @private
+     */
+    getPattern(): number[];
+}