@syncfusion/ej2-pdf 1.0.23 → 23.1.38

package/src/implementation/structured-elements/grid/pdf-grid.d.ts

@@ -1,678 +0,0 @@
-/**
- * PdfGrid.ts class for EJ2-PDF
- */
-import { PdfGridColumnCollection } from './pdf-grid-column';
-import { PdfGridRowCollection, PdfGridHeaderCollection } from './pdf-grid-row';
-import { RectangleF, SizeF, PointF } from './../../drawing/pdf-drawing';
-import { PdfPage } from './../../pages/pdf-page';
-import { PdfLayoutElement } from './../../graphics/figures/layout-element';
-import { PdfLayoutResult, PdfLayoutParams, PdfLayoutFormat } from './../../graphics/figures/base/element-layouter';
-import { PdfGridStyle, PdfGridCellStyle } from './styles/style';
-import { PdfGraphics } from './../../graphics/pdf-graphics';
-/**
- * `PdfGridLayoutFormat` class represents a flexible grid that consists of columns and rows.
- */
-export declare class PdfGridLayoutFormat extends PdfLayoutFormat {
-    /**
-     * Initializes a new instance of the `PdfGridLayoutFormat` class.
-     * @private
-     */
-    constructor();
-    /**
-     * Initializes a new instance of the `PdfGridLayoutFormat` class.
-     * @private
-     */
-    constructor(baseFormat: PdfLayoutFormat);
-}
-export declare class PdfGrid extends PdfLayoutElement {
-    /**
-     * @hidden
-     * @private
-     */
-    private gridColumns;
-    /**
-     * @hidden
-     * @private
-     */
-    private gridRows;
-    /**
-     * @hidden
-     * @private
-     */
-    private gridHeaders;
-    /**
-     * @hidden
-     * @private
-     */
-    private gridInitialWidth;
-    /**
-     * @hidden
-     * @private
-     */
-    isComplete: boolean;
-    /**
-     * @hidden
-     * @private
-     */
-    private gridSize;
-    /**
-     * @hidden
-     * @private
-     */
-    private layoutFormat;
-    /**
-     * @hidden
-     * @private
-     */
-    private gridLocation;
-    /**
-     * @hidden
-     * @private
-     */
-    private gridStyle;
-    /**
-     * @hidden
-     * @private
-     */
-    private pageWidth;
-    /**
-     * Check weather it is `child grid or not`.
-     * @private
-     */
-    private childGrid;
-    /**
-     * @hidden
-     * @private
-     */
-    rowLayoutBoundsWidth: number;
-    /**
-     * @hidden
-     * @private
-     */
-    isRearranged: boolean;
-    /**
-     * @hidden
-     * @private
-     */
-    private bRepeatHeader;
-    /**
-     * @hidden
-     * @private
-     */
-    private pageBounds;
-    /**
-     * @hidden
-     * @private
-     */
-    private currentPage;
-    /**
-     * @hidden
-     * @private
-     */
-    private currentPageBounds;
-    /**
-     * @hidden
-     * @private
-     */
-    private currentBounds;
-    /**
-     * @hidden
-     * @private
-     */
-    private currentGraphics;
-    /**
-     * @hidden
-     * @private
-     */
-    private listOfNavigatePages;
-    /**
-     * @hidden
-     * @private
-     */
-    private startLocation;
-    /**
-     * @hidden
-     * @private
-     */
-    private hType;
-    /**
-     * @hidden
-     * @private
-     */
-    private flag;
-    /**
-     * @hidden
-     * @private
-     */
-    private columnRanges;
-    /**
-     * @hidden
-     * @private
-     */
-    private cellStartIndex;
-    /**
-     * @hidden
-     * @private
-     */
-    private cellEndIndex;
-    /**
-     * @hidden
-     * @private
-     */
-    private currentRowIndex;
-    /**
-     * @hidden
-     * @private
-     */
-    static repeatRowIndex: number;
-    /**
-     * @hidden
-     * @private
-     */
-    private isChanged;
-    /**
-     * @hidden
-     * @private
-     */
-    private currentLocation;
-    /**
-     * @hidden
-     * @private
-     */
-    private breakRow;
-    /**
-     * @hidden
-     * @private
-     */
-    private rowBreakPageHeightCellIndex;
-    /**
-     * The event raised on `starting cell drawing`.
-     * @event
-     * @private
-     */
-    beginCellDraw: Function;
-    /**
-     * The event raised on `ending cell drawing`.
-     * @event
-     * @private
-     */
-    endCellDraw: Function;
-    /**
-     * The event raised on `begin cell lay outing`.
-     * @event
-     * @private
-     */
-    beginPageLayout: Function;
-    /**
-     * The event raised on `end cell lay outing`.
-     * @event
-     * @private
-     */
-    endPageLayout: Function;
-    /**
-     * Initialize a new instance for `PdfGrid` class.
-     * @private
-     */
-    constructor();
-    /**
-     * Gets a value indicating whether the `start cell layout event` should be raised.
-     * @private
-     */
-    readonly raiseBeginCellDraw: boolean;
-    /**
-     * Gets a value indicating whether the `end cell layout event` should be raised.
-     * @private
-     */
-    readonly raiseEndCellDraw: boolean;
-    /**
-     * Gets a value indicating whether the `start page layout event` should be raised.
-     * @private
-     */
-    readonly raiseBeginPageLayout: boolean;
-    /**
-     * Gets a value indicating whether the `ending page layout event` should be raised.
-     * @private
-     */
-    readonly raiseEndPageLayout: boolean;
-    /**
-     * Gets or sets a value indicating whether to `repeat header`.
-     * @private
-     */
-    repeatHeader: boolean;
-    /**
-     * Gets or sets a value indicating whether to split or cut rows that `overflow a page`.
-     * @private
-     */
-    allowRowBreakAcrossPages: boolean;
-    /**
-     * Gets the `column` collection of the PdfGrid.[Read-Only]
-     * @private
-     */
-    readonly columns: PdfGridColumnCollection;
-    /**
-     * Gets the `row` collection from the PdfGrid.[Read-Only]
-     * @private
-     */
-    readonly rows: PdfGridRowCollection;
-    /**
-     * Gets the `headers` collection from the PdfGrid.[Read-Only]
-     * @private
-     */
-    readonly headers: PdfGridHeaderCollection;
-    /**
-     * Indicating `initial width` of the page.
-     * @private
-     */
-    initialWidth: number;
-    /**
-     * Gets or sets the `grid style`.
-     * @private
-     */
-    style: PdfGridStyle;
-    /**
-     * Gets a value indicating whether the grid column width is considered to be `page width`.
-     * @private
-     */
-    isPageWidth: boolean;
-    /**
-     * Gets or set if grid `is nested grid`.
-     * @private
-     */
-    isChildGrid: boolean;
-    /**
-     * Gets the `size`.
-     * @private
-     */
-    size: SizeF;
-    /**
-     * `Draws` the element on the page with the specified page and 'PointF' class
-     * @private
-     */
-    draw(page: PdfPage, location: PointF): PdfLayoutResult;
-    /**
-     * `Draws` the element on the page with the specified page and pair of coordinates
-     * @private
-     */
-    draw(page: PdfPage, x: number, y: number): PdfLayoutResult;
-    /**
-     * `Draws` the element on the page with the specified page and 'RectangleF' class
-     * @private
-     */
-    draw(page: PdfPage, layoutRectangle: RectangleF): PdfLayoutResult;
-    /**
-     * `Draws` the element on the page with the specified page, 'PointF' class and layout format
-     * @private
-     */
-    draw(page: PdfPage, location: PointF, format: PdfLayoutFormat): PdfLayoutResult;
-    /**
-     * `Draws` the element on the page with the specified page, pair of coordinates and layout format
-     * @private
-     */
-    draw(page: PdfPage, x: number, y: number, format: PdfLayoutFormat): PdfLayoutResult;
-    /**
-     * `Draws` the element on the page.
-     * @private
-     */
-    draw(page: PdfPage, layoutRectangle: RectangleF, embedFonts: boolean): PdfLayoutResult;
-    /**
-     * `Draws` the element on the page with the specified page, 'RectangleF' class and layout format
-     * @private
-     */
-    draw(page: PdfPage, layoutRectangle: RectangleF, format: PdfLayoutFormat): PdfLayoutResult;
-    /**
-     * `measures` this instance.
-     * @private
-     */
-    private measure();
-    /**
-     * `Layouts` the specified graphics.
-     * @private
-     */
-    protected layout(param: PdfLayoutParams): PdfLayoutResult;
-    /**
-     * `Layouts` the specified graphics.
-     * @private
-     */
-    protected layout(param: PdfLayoutParams, isGridLayouter: boolean): PdfLayoutResult;
-    setSpan(): void;
-    /**
-     * Gets the `format`.
-     * @private
-     */
-    private getFormat(format);
-    /**
-     * `Layouts` the element.
-     * @private
-     */
-    private layoutInternal(param);
-    /**
-     * Calculates the `width` of the columns.
-     * @private
-     */
-    measureColumnsWidth(): void;
-    /**
-     * Calculates the `width` of the columns.
-     * @private
-     */
-    measureColumnsWidth(bounds: RectangleF): void;
-    /**
-     * `Determines the column draw ranges`.
-     * @private
-     */
-    private determineColumnDrawRanges();
-    /**
-     * `Layouts the on page`.
-     * @private
-     */
-    private layoutOnPage(param);
-    /**
-     * Gets the `next page`.
-     * @private
-     */
-    getNextPage(format: PdfLayoutFormat): PdfPage;
-    /**
-     * Gets the `layout result`.
-     * @private
-     */
-    private getLayoutResult();
-    /**
-     * `Recalculate row height` for the split cell to be drawn.
-     * @private
-     */
-    private ReCalculateHeight(row, height);
-    /**
-     * `Raises BeforePageLayout event`.
-     * @private
-     */
-    private raiseBeforePageLayout(currentPage, currentBounds, currentRow);
-    /**
-     * `Raises PageLayout event` if needed.
-     * @private
-     */
-    private raisePageLayouted(result);
-    /**
-     * `Draws row`
-     * @private
-     */
-    private drawRow(row);
-    /**
-     * `Draws row`
-     * @private
-     */
-    private drawRow(row, result, height);
-    /**
-     * Checks if the given format `is default format` or not.
-     * @private
-     */
-    private CheckIfDefaultFormat(format);
-    /**
-     * `Raises BeforeCellDraw event`.
-     * @private
-     */
-    private RaiseBeforeCellDraw(graphics, rowIndex, cellIndex, bounds, value, style);
-    /**
-     * `Raises AfterCellDraw event`.
-     * @private
-     */
-    private RaiseAfterCellDraw(graphics, rowIndex, cellIndex, bounds, value, cellstyle);
-    /**
-     * `Rearranges the pages`.
-     * @private
-     */
-    private reArrangePages(layoutedPages);
-}
-/**
- * `GridCellEventArgs` class is alternate for grid events.
- */
-export declare abstract class GridCellEventArgs {
-    /**
-     * @hidden
-     * @private
-     */
-    private gridRowIndex;
-    /**
-     * @hidden
-     * @private
-     */
-    private gridCellIndex;
-    /**
-     * @hidden
-     * @private
-     */
-    private internalValue;
-    /**
-     * @hidden
-     * @private
-     */
-    private gridBounds;
-    /**
-     * @hidden
-     * @private
-     */
-    private pdfGraphics;
-    /**
-     * Gets the value of current `row index`.
-     * @private
-     */
-    readonly rowIndex: number;
-    /**
-     * Gets the value of current `cell index`.
-     * @private
-     */
-    readonly cellIndex: number;
-    /**
-     * Gets the actual `value` of current cell.
-     * @private
-     */
-    readonly value: string;
-    /**
-     * Gets the `bounds` of current cell.
-     * @private
-     */
-    readonly bounds: RectangleF;
-    /**
-     * Gets the instance of `current graphics`.
-     * @private
-     */
-    readonly graphics: PdfGraphics;
-    /**
-     * Initialize a new instance for `GridCellEventArgs` class.
-     * @private
-     */
-    constructor(graphics: PdfGraphics, rowIndex: number, cellIndex: number, bounds: RectangleF, value: string);
-}
-/**
- * `PdfGridBeginCellDrawEventArgs` class is alternate for begin cell draw events.
- */
-export declare class PdfGridBeginCellDrawEventArgs extends GridCellEventArgs {
-    /**
-     * @hidden
-     * @private
-     */
-    private bSkip;
-    /**
-     * @hidden
-     * @private
-     */
-    private cellStyle;
-    /**
-     * Gets or sets a value indicating whether the value of this cell should be `skipped`.
-     * @private
-     */
-    skip: boolean;
-    /**
-     * Gets or sets a `style` value of the cell.
-     * @private
-     */
-    style: PdfGridCellStyle;
-    /**
-     * Initializes a new instance of the `StartCellLayoutEventArgs` class.
-     * @private
-     */
-    constructor(graphics: PdfGraphics, rowIndex: number, cellIndex: number, bounds: RectangleF, value: string, style: PdfGridCellStyle);
-}
-/**
- * `PdfGridEndCellDrawEventArgs` class is alternate for end cell draw events.
- */
-export declare class PdfGridEndCellDrawEventArgs extends GridCellEventArgs {
-    /**
-     * @hidden
-     * @private
-     */
-    private cellStyle;
-    /**
-     * Get the `PdfGridCellStyle`.
-     * @private
-     */
-    readonly style: PdfGridCellStyle;
-    /**
-     * Initializes a new instance of the `PdfGridEndCellLayoutEventArgs` class.
-     * @private
-     */
-    constructor(graphics: PdfGraphics, rowIndex: number, cellIndex: number, bounds: RectangleF, value: string, style: PdfGridCellStyle);
-}
-/**
- * `PdfGridCancelEventArgs` class is alternate for cancel events.
- */
-export declare class PdfCancelEventArgs {
-    /**
-     * @hidden
-     * @private
-     */
-    private isCancel;
-    /**
-     * Gets and Sets the value of `cancel`.
-     * @private
-     */
-    cancel: boolean;
-}
-/**
- * `BeginPageLayoutEventArgs` class is alternate for begin page layout events.
- */
-export declare class BeginPageLayoutEventArgs extends PdfCancelEventArgs {
-    /**
-     * The `bounds` of the lay outing on the page.
-     * @private
-     */
-    private cellBounds;
-    /**
-     * `Page` where the lay outing should start.
-     * @private
-     */
-    private pdfPage;
-    /**
-     * Gets or sets value that indicates the lay outing `bounds` on the page.
-     * @private
-     */
-    bounds: RectangleF;
-    /**
-     * Gets the `page` where the lay outing should start.
-     * @private
-     */
-    readonly page: PdfPage;
-    /**
-     * Initializes a new instance of the `BeginPageLayoutEventArgs` class with the specified rectangle and page.
-     * @private
-     */
-    constructor(bounds: RectangleF, page: PdfPage);
-}
-/**
- * `EndPageLayoutEventArgs` class is alternate for end page layout events.
- */
-export declare class EndPageLayoutEventArgs extends PdfCancelEventArgs {
-    /**
-     * `Layout result`.
-     * @private
-     */
-    private layoutResult;
-    /**
-     * The `next page` for lay outing.
-     * @private
-     */
-    private nextPdfPage;
-    /**
-     * Gets the lay outing `result` of the page.
-     * @private
-     */
-    readonly result: PdfLayoutResult;
-    /**
-     * Gets or sets a value indicating the `next page` where the element should be layout.
-     * @private
-     */
-    nextPage: PdfPage;
-    /**
-     * Initializes a new instance of the `EndPageLayoutEventArgs` class. with the specified 'PdfLayoutResult'.
-     * @private
-     */
-    constructor(result: PdfLayoutResult);
-}
-/**
- * `PdfGridBeginPageLayoutEventArgs` class is alternate for begin page layout events.
- */
-export declare class PdfGridBeginPageLayoutEventArgs extends BeginPageLayoutEventArgs {
-    /**
-     * @hidden
-     * @private
-     */
-    private startRow;
-    /**
-     * Gets the `start row index`.
-     * @private
-     */
-    readonly startRowIndex: number;
-    /**
-     * Initialize a new instance of `PdfGridBeginPageLayoutEventArgs` class.
-     * @private
-     */
-    constructor(bounds: RectangleF, page: PdfPage, startRow: number);
-}
-/**
- * `PdfGridEndPageLayoutEventArgs` class is alternate for begin page layout events.
- */
-export declare class PdfGridEndPageLayoutEventArgs extends EndPageLayoutEventArgs {
-    /**
-     * Initialize a new instance of `PdfGridEndPageLayoutEventArgs` class.
-     * @private
-     */
-    constructor(result: PdfLayoutResult);
-}
-/**
- * `RowLayoutResult` class to store layout result of rows.
- */
-export declare class RowLayoutResult {
-    /**
-     * @hidden
-     * @private
-     */
-    private bIsFinished;
-    /**
-     * @hidden
-     * @private
-     */
-    private layoutedBounds;
-    /**
-     * Gets or sets a value indicating whether this instance `is finish`.
-     * @private
-     */
-    isFinish: boolean;
-    /**
-     * Gets or sets the `bounds`.
-     * @private
-     */
-    bounds: RectangleF;
-    /**
-     * Initializes a new instance of the `RowLayoutResult` class.
-     * @private
-     */
-    constructor();
-}
-/**
- * `PdfGridLayoutResult` class represents the results of the PdfGrid including bounds and resultant page.
- */
-export declare class PdfGridLayoutResult extends PdfLayoutResult {
-    /**
-     * Initializes a new instance of the `PdfGridLayoutResult` class with the current page and bounds.
-     * @private
-     */
-    constructor(page: PdfPage, bounds: RectangleF);
-}