@syncfusion/ej2-pdf-export 25.2.3 → 26.1.35

package/dist/ts/implementation/structured-elements/grid/styles/index.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Grid styles classes
+ */
+export * from './pdf-borders';
+export * from './style';

package/dist/ts/implementation/structured-elements/grid/styles/index.ts

@@ -0,0 +1,5 @@
+/**
+ * Grid styles classes
+ */
+export * from './pdf-borders';
+export * from './style';

package/dist/ts/implementation/structured-elements/grid/styles/pdf-borders.d.ts

@@ -0,0 +1,146 @@
+/**
+ * PdfBorders.ts class for EJ2-PDF
+ */
+import { PdfPen } from './../../../graphics/pdf-pen';
+/**
+ * `PdfBorders` class used represents the cell border of the PDF grid.
+ */
+export declare class PdfBorders {
+    /**
+     * The `left` border.
+     * @private
+     */
+    private leftPen;
+    /**
+     * The `right` border.
+     * @private
+     */
+    private rightPen;
+    /**
+     * The `top` border.
+     * @private
+     */
+    private topPen;
+    /**
+     * The `bottom` border.
+     * @private
+     */
+    private bottomPen;
+    /**
+     * Gets or sets the `Left`.
+     * @private
+     */
+    left: PdfPen;
+    /**
+     * Gets or sets the `Right`.
+     * @private
+     */
+    right: PdfPen;
+    /**
+     * Gets or sets the `Top`.
+     * @private
+     */
+    top: PdfPen;
+    /**
+     * Gets or sets the `Bottom`.
+     * @private
+     */
+    bottom: PdfPen;
+    /**
+     * sets the `All`.
+     * @private
+     */
+    all: PdfPen;
+    /**
+     * Gets a value indicating whether this instance `is all`.
+     * @private
+     */
+    readonly isAll: boolean;
+    /**
+     * Gets the `default`.
+     * @private
+     */
+    static readonly default: PdfBorders;
+    /**
+     * Create a new instance for `PdfBorders` class.
+     * @private
+     */
+    constructor();
+}
+export declare class PdfPaddings {
+    /**
+     * The `left` padding.
+     * @private
+     */
+    private leftPad;
+    /**
+     * The `right` padding.
+     * @private
+     */
+    private rightPad;
+    /**
+     * The `top` padding.
+     * @private
+     */
+    private topPad;
+    /**
+     * The `bottom` padding.
+     * @private
+     */
+    private bottomPad;
+    /**
+     * The 'left' border padding set.
+     * @private
+     */
+    hasLeftPad: boolean;
+    /**
+     * The 'right' border padding set.
+     * @private
+     */
+    hasRightPad: boolean;
+    /**
+     * The 'top' border padding set.
+     * @private
+     */
+    hasTopPad: boolean;
+    /**
+     * The 'bottom' border padding set.
+     * @private
+     */
+    hasBottomPad: boolean;
+    /**
+     * Gets or sets the `left` value of the edge
+     * @private
+     */
+    left: number;
+    /**
+     * Gets or sets the `right` value of the edge.
+     * @private
+     */
+    right: number;
+    /**
+     * Gets or sets the `top` value of the edge
+     * @private
+     */
+    top: number;
+    /**
+     * Gets or sets the `bottom` value of the edge.
+     * @private
+     */
+    bottom: number;
+    /**
+     * Sets value to all sides `left,right,top and bottom`.s
+     * @private
+     */
+    all: number;
+    /**
+     * Initializes a new instance of the `PdfPaddings` class.
+     * @private
+     */
+    constructor();
+    /**
+     * Initializes a new instance of the `PdfPaddings` class.
+     * @private
+     */
+    constructor(left: number, right: number, top: number, bottom: number);
+}

package/dist/ts/implementation/structured-elements/grid/styles/pdf-borders.ts

@@ -0,0 +1,240 @@
+/**
+ * PdfBorders.ts class for EJ2-PDF
+ */
+import { PdfPen } from './../../../graphics/pdf-pen';
+import { PdfDashStyle } from './../../../graphics/enum';
+import { PdfColor } from './../../../graphics/pdf-color';
+/**
+ * `PdfBorders` class used represents the cell border of the PDF grid.
+ */
+export class PdfBorders {
+    // Fields
+    /**
+     * The `left` border.
+     * @private
+     */
+    private leftPen : PdfPen;
+    /**
+     * The `right` border.
+     * @private
+     */
+    private rightPen : PdfPen;
+    /**
+     * The `top` border.
+     * @private
+     */
+    private topPen : PdfPen;
+    /**
+     * The `bottom` border.
+     * @private
+     */
+    private bottomPen : PdfPen;
+    // Properties
+    /**
+     * Gets or sets the `Left`.
+     * @private
+     */
+    public get left() : PdfPen {
+        return this.leftPen;
+    }
+    public set left(value : PdfPen) {
+        this.leftPen = value;
+    }
+    /**
+     * Gets or sets the `Right`.
+     * @private
+     */
+    public get right() : PdfPen {
+        return this.rightPen;
+    }
+    public set right(value : PdfPen) {
+        this.rightPen = value;
+    }
+    /**
+     * Gets or sets the `Top`.
+     * @private
+     */
+    public get top() : PdfPen {
+        return this.topPen;
+    }
+    public set top(value : PdfPen) {
+        this.topPen = value;
+    }
+    /**
+     * Gets or sets the `Bottom`.
+     * @private
+     */
+    public get bottom() : PdfPen {
+        return this.bottomPen;
+    }
+    public set bottom(value : PdfPen) {
+        this.bottomPen = value;
+    }
+    /**
+     * sets the `All`.
+     * @private
+     */
+    public set all(value : PdfPen) {
+        this.leftPen = this.rightPen = this.topPen = this.bottomPen = value;
+    }
+    /**
+     * Gets a value indicating whether this instance `is all`.
+     * @private
+     */
+    public get isAll() : boolean {
+        return ((this.leftPen === this.rightPen) && (this.leftPen === this.topPen) && (this.leftPen === this.bottomPen));
+    }
+    /**
+     * Gets the `default`.
+     * @private
+     */
+    public static get default() : PdfBorders {
+        return new PdfBorders();
+    }
+
+    // Constructor
+    /**
+     * Create a new instance for `PdfBorders` class.
+     * @private
+     */
+    public constructor() {
+        let defaultBorderPenLeft : PdfPen = new PdfPen(new PdfColor(0, 0, 0));
+        defaultBorderPenLeft.dashStyle = PdfDashStyle.Solid;
+        let defaultBorderPenRight : PdfPen = new PdfPen(new PdfColor(0, 0, 0));
+        defaultBorderPenRight.dashStyle = PdfDashStyle.Solid;
+        let defaultBorderPenTop : PdfPen = new PdfPen(new PdfColor(0, 0, 0));
+        defaultBorderPenTop.dashStyle = PdfDashStyle.Solid;
+        let defaultBorderPenBottom : PdfPen = new PdfPen(new PdfColor(0, 0, 0));
+        defaultBorderPenBottom.dashStyle = PdfDashStyle.Solid;
+        this.leftPen = defaultBorderPenLeft;
+        this.rightPen = defaultBorderPenRight;
+        this.topPen = defaultBorderPenTop;
+        this.bottomPen = defaultBorderPenBottom;
+    }
+}
+export class PdfPaddings {
+    //Fields
+    /**
+     * The `left` padding.
+     * @private
+     */
+    private leftPad : number;
+    /**
+     * The `right` padding.
+     * @private
+     */
+    private rightPad : number;
+    /**
+     * The `top` padding.
+     * @private
+     */
+    private topPad : number;
+    /**
+     * The `bottom` padding.
+     * @private
+     */
+    private bottomPad : number;
+    /**
+     * The 'left' border padding set.
+     * @private
+     */
+    public hasLeftPad : boolean = false;
+    /**
+     * The 'right' border padding set.
+     * @private
+     */
+    public hasRightPad : boolean = false;
+    /**
+     * The 'top' border padding set.
+     * @private
+     */
+    public hasTopPad : boolean = false;
+    /**
+     * The 'bottom' border padding set.
+     * @private
+     */
+    public hasBottomPad : boolean = false;
+    // Properties
+    /**
+     * Gets or sets the `left` value of the edge
+     * @private
+     */
+    public get left() : number {
+        return this.leftPad;
+    }
+    public set left(value : number) {
+        this.leftPad = value;
+        this.hasLeftPad = true;
+    }
+    /**
+     * Gets or sets the `right` value of the edge.
+     * @private
+     */
+    public get right() : number {
+        return this.rightPad;
+    }
+    public set right(value : number) {
+        this.rightPad = value;
+        this.hasRightPad = true;
+    }
+    /**
+     * Gets or sets the `top` value of the edge
+     * @private
+     */
+    public get top() : number {
+        return this.topPad;
+    }
+    public set top(value : number) {
+        this.topPad = value;
+        this.hasTopPad = true;
+    }
+    /**
+     * Gets or sets the `bottom` value of the edge.
+     * @private
+     */
+    public get bottom() : number {
+        return this.bottomPad;
+    }
+    public set bottom(value : number) {
+        this.bottomPad = value;
+        this.hasBottomPad = true;
+    }
+    /**
+     * Sets value to all sides `left,right,top and bottom`.s
+     * @private
+     */
+    public set all(value : number) {
+        this.leftPad = this.rightPad = this.topPad = this.bottomPad = value;
+        this.hasLeftPad = true;
+        this.hasRightPad = true;
+        this.hasTopPad = true;
+        this.hasBottomPad = true;
+    }
+    /**
+     * Initializes a new instance of the `PdfPaddings` class.
+     * @private
+     */
+    public constructor()
+    /**
+     * Initializes a new instance of the `PdfPaddings` class.
+     * @private
+     */
+    public constructor(left : number, right : number, top : number, bottom : number)
+    public constructor(left ?: number, right ?: number, top ?: number, bottom ?: number) {
+        if (typeof left === 'undefined') {
+            //5.76 and 0 are taken from ms-word default table margins.
+            this.leftPad = this.rightPad = 5.76;
+            //0.5 is set for top and bottom by default.
+            this.bottomPad = this.topPad = 0.5;
+        } else {
+            this.leftPad = left;
+            this.rightPad = right;
+            this.topPad = top;
+            this.bottomPad = bottom;
+            this.hasLeftPad = true;
+            this.hasRightPad = true;
+            this.hasTopPad = true;
+            this.hasBottomPad = true;
+        }
+    }
+}

package/dist/ts/implementation/structured-elements/grid/styles/style.d.ts

@@ -0,0 +1,272 @@
+/**
+ * PdfGridStyleBase.ts class for EJ2-PDF
+ */
+import { PdfBrush } from './../../../graphics/brushes/pdf-brush';
+import { PdfPen } from './../../../graphics/pdf-pen';
+import { PdfFont } from './../../../graphics/fonts/pdf-font';
+import { PdfBorders, PdfPaddings } from './pdf-borders';
+import { PdfBorderOverlapStyle } from './../../tables/light-tables/enum';
+import { PdfStringFormat } from './../../../graphics/fonts/pdf-string-format';
+import { PdfGridRow } from './../pdf-grid-row';
+import { PdfImage } from './../../../graphics/images/pdf-image';
+/**
+ * Base class for the `grid style`,
+ */
+export declare abstract class PdfGridStyleBase {
+    /**
+     * @hidden
+     * @private
+     */
+    private gridBackgroundBrush;
+    /**
+     * @hidden
+     * @private
+     */
+    private gridTextBrush;
+    /**
+     * @hidden
+     * @private
+     */
+    private gridTextPen;
+    /**
+     * @hidden
+     * @private
+     */
+    private gridFont;
+    /**
+     * @hidden
+     * @private
+     */
+    private gridBackgroundImage;
+    /**
+     * Gets or sets the `background brush`.
+     * @private
+     */
+    backgroundBrush: PdfBrush;
+    /**
+     * Gets or sets the `text brush`.
+     * @private
+     */
+    textBrush: PdfBrush;
+    /**
+     * Gets or sets the `text pen`.
+     * @private
+     */
+    textPen: PdfPen;
+    /**
+     * Gets or sets the `font`.
+     * @private
+     */
+    font: PdfFont;
+    /**
+     * Gets or sets the `background Image`.
+     * @private
+     */
+    backgroundImage: PdfImage;
+}
+/**
+ * `PdfGridStyle` class provides customization of the appearance for the 'PdfGrid'.
+ */
+export declare class PdfGridStyle extends PdfGridStyleBase {
+    /**
+     * @hidden
+     * @private
+     */
+    private gridBorderOverlapStyle;
+    /**
+     * @hidden
+     * @private
+     */
+    private gridHorizontalOverflowType;
+    /**
+     * @hidden
+     * @private
+     */
+    private bAllowHorizontalOverflow;
+    /**
+     * @hidden
+     * @private
+     */
+    private gridCellPadding;
+    /**
+     * @hidden
+     * @private
+     */
+    private gridCellSpacing;
+    /**
+     * Initialize a new instance for `PdfGridStyle` class.
+     * @private
+     */
+    constructor();
+    /**
+     * Gets or sets the `cell spacing` of the 'PdfGrid'.
+     * @private
+     */
+    cellSpacing: number;
+    /**
+     * Gets or sets the type of the `horizontal overflow` of the 'PdfGrid'.
+     * @private
+     */
+    horizontalOverflowType: PdfHorizontalOverflowType;
+    /**
+     * Gets or sets a value indicating whether to `allow horizontal overflow`.
+     * @private
+     */
+    allowHorizontalOverflow: boolean;
+    /**
+     * Gets or sets the `cell padding`.
+     * @private
+     */
+    cellPadding: PdfPaddings;
+    /**
+     * Gets or sets the `border overlap style` of the 'PdfGrid'.
+     * @private
+     */
+    borderOverlapStyle: PdfBorderOverlapStyle;
+}
+/**
+ * `PdfGridCellStyle` class provides customization of the appearance for the 'PdfGridCell'.
+ */
+export declare class PdfGridCellStyle extends PdfGridStyleBase {
+    /**
+     * @hidden
+     * @private
+     */
+    private gridCellBorders;
+    /**
+     * @hidden
+     * @private
+     */
+    private gridCellPadding;
+    /**
+     * @hidden
+     * @private
+     */
+    private format;
+    /**
+     * Gets the `string format` of the 'PdfGridCell'.
+     * @private
+     */
+    stringFormat: PdfStringFormat;
+    /**
+     * Gets or sets the `border` of the 'PdfGridCell'.
+     * @private
+     */
+    borders: PdfBorders;
+    /**
+     * Gets or sets the `cell padding`.
+     * @private
+     */
+    cellPadding: PdfPaddings;
+    /**
+     * Initializes a new instance of the `PdfGridCellStyle` class.
+     * @private
+     */
+    constructor();
+}
+/**
+ * `PdfGridRowStyle` class provides customization of the appearance for the `PdfGridRow`.
+ */
+export declare class PdfGridRowStyle {
+    /**
+     * @hidden
+     * @private
+     */
+    private gridRowBackgroundBrush;
+    /**
+     * @hidden
+     * @private
+     */
+    private gridRowTextBrush;
+    /**
+     * @hidden
+     * @private
+     */
+    private gridRowTextPen;
+    /**
+     * @hidden
+     * @private
+     */
+    private gridRowFont;
+    /**
+     * Specifies the `border` value of the current row.
+     * @private
+     */
+    private gridRowBorder;
+    /**
+     * Specifies the `parent row` of the current object.
+     * @private
+     */
+    private parent;
+    /**
+     * @hidden
+     * @private
+     */
+    private gridRowBackgroundImage;
+    /**
+     * Gets or sets the `background brush`.
+     * @private
+     */
+    readonly backgroundBrush: PdfBrush;
+    setBackgroundBrush(value: PdfBrush): void;
+    /**
+     * Gets or sets the `text brush`.
+     * @private
+     */
+    readonly textBrush: PdfBrush;
+    setTextBrush(value: PdfBrush): void;
+    /**
+     * Gets or sets the `text pen`.
+     * @private
+     */
+    readonly textPen: PdfPen;
+    setTextPen(value: PdfPen): void;
+    /**
+     * Gets or sets the `font`.
+     * @private
+     */
+    readonly font: PdfFont;
+    setFont(value: PdfFont): void;
+    /**
+     * Gets or sets the `border` of the current row.
+     * @private
+     */
+    readonly border: PdfBorders;
+    setBorder(value: PdfBorders): void;
+    /**
+     * sets the `parent row` of the current object.
+     * @private
+     */
+    setParent(parent: PdfGridRow): void;
+    /**
+     * Gets or sets the `backgroundImage` of the 'PdfGridCell'.
+     * @private
+     */
+    readonly backgroundImage: PdfImage;
+    /**
+     * sets the `backgroundImage` of the 'PdfGridCell'.
+     * @private
+     */
+    setBackgroundImage(value: PdfImage): void;
+    /**
+     * Initializes a new instance of the `PdfGridRowStyle` class.
+     * @private
+     */
+    constructor();
+}
+/**
+ * public Enum for `PdfHorizontalOverflowType`.
+ * @private
+ */
+export declare enum PdfHorizontalOverflowType {
+    /**
+     * Specifies the type of `NextPage`.
+     * @private
+     */
+    NextPage = 0,
+    /**
+     * Specifies the type of `LastPage`.
+     * @private
+     */
+    LastPage = 1
+}