@syncfusion/ej2-pdf-export 25.2.3 → 26.2.4

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

@@ -0,0 +1,108 @@
+/**
+ * `PdfGridColumn.ts` class for EJ2-PDF
+ */
+import { PdfGrid } from './pdf-grid';
+import { PdfStringFormat } from './../../graphics/fonts/pdf-string-format';
+/**
+ * `PdfGridColumn` class represents the schema of a column in a 'PdfGrid'.
+ */
+export declare class PdfGridColumn {
+    /**
+     * The current `grid`.
+     * @private
+     */
+    private grid;
+    /**
+     * The `width` of the column.
+     * @default 0
+     * @private
+     */
+    columnWidth: number;
+    /**
+     * Represent the `custom width` of the column.
+     * @private
+     */
+    isCustomWidth: boolean;
+    /**
+     * The `string format` of the column.
+     * @private
+     */
+    private stringFormat;
+    /**
+     * Initializes a new instance of the `PdfGridColumn` class with the parent grid.
+     * @private
+     */
+    constructor(grid: PdfGrid);
+    /**
+     * Gets or sets the `width` of the 'PdfGridColumn'.
+     * @private
+     */
+    width: number;
+    /**
+     * Gets or sets the information about the text `formatting`.
+     * @private
+     */
+    format: PdfStringFormat;
+}
+/**
+ * `PdfGridColumnCollection` class provides access to an ordered,
+ * strongly typed collection of 'PdfGridColumn' objects.
+ * @private
+ */
+export declare class PdfGridColumnCollection {
+    /**
+     * @hidden
+     * @private
+     */
+    private grid;
+    /**
+     * @hidden
+     * @private
+     */
+    private internalColumns;
+    /**
+     * @hidden
+     * @private
+     */
+    private columnWidth;
+    /**
+     * Initializes a new instance of the `PdfGridColumnCollection` class with the parent grid.
+     * @private
+     */
+    constructor(grid: PdfGrid);
+    /**
+     * `Add` a new column to the 'PdfGrid'.
+     * @private
+     */
+    add(count: number): void;
+    /**
+     * Gets the `number of columns` in the 'PdfGrid'.[Read-Only].
+     * @private
+     */
+    readonly count: number;
+    /**
+     * Gets the `widths`.
+     * @private
+     */
+    readonly width: number;
+    /**
+     * Gets the `array of PdfGridColumn`.[Read-Only]
+     * @private
+     */
+    readonly columns: PdfGridColumn[];
+    /**
+     * Gets the `PdfGridColumn` from the specified index.[Read-Only]
+     * @private
+     */
+    getColumn(index: number): PdfGridColumn;
+    /**
+     * `Calculates the column widths`.
+     * @private
+     */
+    measureColumnsWidth(): number;
+    /**
+     * Gets the `widths of the columns`.
+     * @private
+     */
+    getDefaultWidths(totalWidth: number): number[];
+}

package/dist/ts/implementation/structured-elements/grid/pdf-grid-column.ts

@@ -0,0 +1,206 @@
+/**
+ * `PdfGridColumn.ts` class for EJ2-PDF
+ */
+import { PdfGrid } from './pdf-grid';
+import { PdfGridRow } from './pdf-grid-row';
+import { PdfGridCell } from './pdf-grid-cell';
+import { PdfStringFormat } from './../../graphics/fonts/pdf-string-format';
+/**
+ * `PdfGridColumn` class represents the schema of a column in a 'PdfGrid'.
+ */
+export class PdfGridColumn {
+    //Fields
+    /**
+     * The current `grid`.
+     * @private
+     */
+    private grid : PdfGrid;
+    /**
+     * The `width` of the column.
+     * @default 0
+     * @private
+     */
+    public columnWidth : number = 0;
+    /**
+     * Represent the `custom width` of the column.
+     * @private
+     */
+    public isCustomWidth : boolean;
+    /**
+     * The `string format` of the column.
+     * @private
+     */
+    private stringFormat : PdfStringFormat;
+    //Constructors
+    /**
+     * Initializes a new instance of the `PdfGridColumn` class with the parent grid.
+     * @private
+     */
+    public constructor(grid : PdfGrid) {
+        this.grid = grid;
+    }
+    /**
+     * Gets or sets the `width` of the 'PdfGridColumn'.
+     * @private
+     */
+    public get width() : number {
+        return this.columnWidth;
+    }
+    public set width(value : number) {
+        this.isCustomWidth = true;
+        this.columnWidth = value;
+    }
+    /**
+     * Gets or sets the information about the text `formatting`.
+     * @private
+     */
+    public get format() : PdfStringFormat {
+        if (this.stringFormat == null) {
+            this.stringFormat = new PdfStringFormat(); //GetDefaultFormat();
+        }
+        return this.stringFormat;
+    }
+    public set format(value : PdfStringFormat) {
+        this.stringFormat = value;
+    }
+}
+/**
+ * `PdfGridColumnCollection` class provides access to an ordered,
+ * strongly typed collection of 'PdfGridColumn' objects.
+ * @private
+ */
+export class PdfGridColumnCollection {
+    //Fields
+    /**
+     * @hidden
+     * @private
+     */
+    private grid : PdfGrid;
+    /**
+     * @hidden
+     * @private
+     */
+    private internalColumns : PdfGridColumn[] = [];
+    /**
+     * @hidden
+     * @private
+     */
+    private columnWidth : number = 0;
+    //properties
+
+    //Constructors
+    /**
+     * Initializes a new instance of the `PdfGridColumnCollection` class with the parent grid.
+     * @private
+     */
+    public constructor(grid : PdfGrid) {
+        this.grid = grid;
+        this.internalColumns = [];
+    }
+    //Iplementation
+    /**
+     * `Add` a new column to the 'PdfGrid'.
+     * @private
+     */
+    public add(count : number) : void {
+    // public add(column : PdfGridColumn) : void
+    // public add(arg : number|PdfGridColumn) : void {
+        // if (typeof arg === 'number') {
+        for (let i : number = 0; i < count; i++) {
+            this.internalColumns.push(new PdfGridColumn(this.grid));
+            for (let index : number = 0; index < this.grid.rows.count; index++) {
+                let row : PdfGridRow = this.grid.rows.getRow(index);
+                let cell : PdfGridCell = new PdfGridCell();
+                cell.value = '';
+                row.cells.add(cell);
+            }
+        }
+        // } else {
+        //     let column : PdfGridColumn = new PdfGridColumn(this.grid);
+        //     this.columns.push(column);
+        //     return column;
+        // }
+    }
+    /**
+     * Gets the `number of columns` in the 'PdfGrid'.[Read-Only].
+     * @private
+     */
+    public get count() : number {
+        return this.internalColumns.length;
+    }
+    /**
+     * Gets the `widths`.
+     * @private
+     */
+    public get width() : number {
+        if (this.columnWidth === 0 ) {
+            this.columnWidth = this.measureColumnsWidth();
+        }
+        if (this.grid.initialWidth !== 0 && this.columnWidth !== this.grid.initialWidth && !this.grid.style.allowHorizontalOverflow) {
+            this.columnWidth = this.grid.initialWidth;
+            this.grid.isPageWidth = true;
+        }
+        return this.columnWidth;
+    }
+    /**
+     * Gets the `array of PdfGridColumn`.[Read-Only]
+     * @private
+     */
+    public get columns() : PdfGridColumn[] {
+        return this.internalColumns;
+    }
+    /**
+     * Gets the `PdfGridColumn` from the specified index.[Read-Only]
+     * @private
+     */
+    public getColumn(index : number) : PdfGridColumn {
+        if (index >= 0 && index <= this.columns.length) {
+            return this.columns[index];
+        } else {
+            throw Error('can not get the column from the index: ' + index);
+        }
+    }
+
+    //Implementation
+    /**
+     * `Calculates the column widths`.
+     * @private
+     */
+    public measureColumnsWidth() : number {
+        let totalWidth : number = 0;
+        this.grid.measureColumnsWidth();
+        for (let i : number = 0, count : number = this.internalColumns.length; i < count; i++) {
+            totalWidth += this.internalColumns[i].width;
+        }
+        return totalWidth;
+    }
+    /**
+     * Gets the `widths of the columns`.
+     * @private
+     */
+    public getDefaultWidths(totalWidth : number) : number[] {
+        let widths : number[] = [];
+        let summ : number = 0.0;
+        let subFactor : number = this.count;
+        for (let i : number = 0; i < this.count; i++) {
+            if (this.grid.isPageWidth && totalWidth >= 0 && !this.internalColumns[i].isCustomWidth) {
+                this.internalColumns[i].width = 0;
+            } else {
+                widths[i] = this.internalColumns[i].width;
+                if (this.internalColumns[i].width > 0 && this. internalColumns[i].isCustomWidth) {
+                    totalWidth -= this.internalColumns[i].width;
+                    subFactor--;
+                } else {
+                    widths[i] = 0;
+                }
+            }
+        }
+        for (let i : number = 0; i < this.count; i++) {
+            let width : number = totalWidth / subFactor;
+            if (widths[i] <= 0) {
+                widths[i] = width;
+            }
+        }
+        return widths;
+    }
+}

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

@@ -0,0 +1,261 @@
+/**
+ * PdfGridRow.ts class for EJ2-PDF
+ */
+import { PdfGrid } from './pdf-grid';
+import { PdfGridCellCollection } from './pdf-grid-cell';
+import { PdfGridRowStyle } from './styles/style';
+import { PdfLayoutResult } from '../../graphics/figures/base/element-layouter';
+/**
+ * `PdfGridRow` class provides customization of the settings for the particular row.
+ */
+export declare class PdfGridRow {
+    /**
+     * `Cell collecton` of the current row..
+     * @private
+     */
+    private gridCells;
+    /**
+     * Stores the current `grid`.
+     * @private
+     */
+    private pdfGrid;
+    /**
+     * The grid row `style`.
+     * @private
+     */
+    private rowStyle;
+    /**
+     * Stores the row `break height`.
+     * @private
+     */
+    private gridRowBreakHeight;
+    /**
+     * Stores the index of the overflowing row.
+     * @private
+     */
+    private gridRowOverflowIndex;
+    /**
+     * The `height` of the row.
+     * @private
+     */
+    private rowHeight;
+    /**
+     * The `width` of the row.
+     * @private
+     */
+    private rowWidth;
+    /**
+     * The `isFinish` of the row.
+     * @private
+     */
+    isrowFinish: boolean;
+    /**
+     * Check whether the Row span row height `is set explicitly`.
+     * @default false
+     * @public
+     */
+    isRowSpanRowHeightSet: boolean;
+    /**
+     * The grid row `Layout Result`.
+     * @private
+     */
+    private gridResult;
+    /**
+     * The `Maximum span` of the row.
+     * @public
+     */
+    maximumRowSpan: number;
+    /**
+     * The `page count` of the row.
+     * @public
+     */
+    noOfPageCount: number;
+    /**
+     * Check whether the row height `is set explicitly`.
+     * @default false
+     * @private
+     */
+    isRowHeightSet: boolean;
+    isRowBreaksNextPage: boolean;
+    rowBreakHeightValue: number;
+    isPageBreakRowSpanApplied: boolean;
+    /**
+     * Checks whether the `columns span is exist or not`.
+     * @private
+     */
+    private bColumnSpanExists;
+    /**
+     * Check weather the row merge `is completed` or not.
+     * @default true
+     * @private
+     */
+    private isRowMergeComplete;
+    /**
+     * Checks whether the `row span is exist or not`.
+     * @private
+     */
+    private bRowSpanExists;
+    repeatFlag: boolean;
+    repeatRowNumber: number;
+    rowFontSplit: boolean;
+    isHeaderRow: boolean;
+    /**
+     * Initializes a new instance of the `PdfGridRow` class with the parent grid.
+     * @private
+     */
+    constructor(grid: PdfGrid);
+    /**
+     * Gets or sets a value indicating [`row span exists`].
+     * @private
+     */
+    rowSpanExists: boolean;
+    /**
+     * Gets the `cells` from the selected row.[Read-Only].
+     * @private
+     */
+    readonly cells: PdfGridCellCollection;
+    /**
+     * Gets or sets the parent `grid`.
+     * @private
+     */
+    grid: PdfGrid;
+    /**
+     * Gets or sets the row `style`.
+     * @private
+     */
+    style: PdfGridRowStyle;
+    /**
+     * `Height` of the row yet to be drawn after split.
+     * @private
+     */
+    rowBreakHeight: number;
+    /**
+     * `over flow index` of the row.
+     * @private
+     */
+    rowOverflowIndex: number;
+    /**
+     * Gets or sets the `height` of the row.
+     * @private
+     */
+    height: number;
+    /**
+     * Gets or sets the `width` of the row.
+     * @private
+     */
+    readonly width: number;
+    /**
+     * Gets or sets the row `Nested grid Layout Result`.
+     * @private
+     */
+    NestedGridLayoutResult: PdfLayoutResult;
+    /**
+     * Gets or sets a value indicating [`column span exists`].
+     * @private
+     */
+    columnSpanExists: boolean;
+    /**
+     * Check whether the Row `has row span or row merge continue`.
+     * @private
+     */
+    rowMergeComplete: boolean;
+    /**
+     * Returns `index` of the row.
+     * @private
+     */
+    readonly rowIndex: number;
+    /**
+     * `Calculates the height`.
+     * @private
+     */
+    private measureHeight;
+    private measureWidth;
+}
+/**
+ * `PdfGridRowCollection` class provides access to an ordered, strongly typed collection of 'PdfGridRow' objects.
+ * @private
+ */
+export declare class PdfGridRowCollection {
+    /**
+     * @hidden
+     * @private
+     */
+    private grid;
+    /**
+     * The row collection of the `grid`.
+     * @private
+     */
+    private rows;
+    /**
+     * Initializes a new instance of the `PdfGridRowCollection` class with the parent grid.
+     * @private
+     */
+    constructor(grid: PdfGrid);
+    /**
+     * Gets the number of header in the `PdfGrid`.[Read-Only].
+     * @private
+     */
+    readonly count: number;
+    /**
+     * Return the row collection of the `grid`.
+     * @private
+     */
+    readonly rowCollection: PdfGridRow[];
+    /**
+     * `Adds` the specified row.
+     * @private
+     */
+    addRow(): PdfGridRow;
+    /**
+     * `Adds` the specified row.
+     * @private
+     */
+    addRow(row: PdfGridRow): void;
+    /**
+     * Return the row by index.
+     * @private
+     */
+    getRow(index: number): PdfGridRow;
+}
+/**
+ * `PdfGridHeaderCollection` class provides customization of the settings for the header.
+ * @private
+ */
+export declare class PdfGridHeaderCollection {
+    /**
+     * The `grid`.
+     * @private
+     */
+    private grid;
+    /**
+     * The array to store the `rows` of the grid header.
+     * @private
+     */
+    private rows;
+    /**
+     * Initializes a new instance of the `PdfGridHeaderCollection` class with the parent grid.
+     * @private
+     */
+    constructor(grid: PdfGrid);
+    /**
+     * Gets a 'PdfGridRow' object that represents the `header` row in a 'PdfGridHeaderCollection' control.[Read-Only].
+     * @private
+     */
+    getHeader(index: number): PdfGridRow;
+    /**
+     * Gets the `number of header` in the 'PdfGrid'.[Read-Only]
+     * @private
+     */
+    readonly count: number;
+    /**
+     * `Adds` the specified row.
+     * @private
+     */
+    add(row: PdfGridRow): void;
+    /**
+     * `Adds` the specified row.
+     * @private
+     */
+    add(count: number): PdfGridRow[];
+    indexOf(row: PdfGridRow): number;
+}