@grapecity/wijmo.grid.pdf 5.20252.44 → 5.20261.48

package/index.d.ts

@@ -1,6 +1,6 @@
 /*!
     *
-    * Wijmo Library 5.20252.44
+    * Wijmo Library 5.20261.48
     * https://developer.mescius.com/wijmo
     *
     * Copyright(c) MESCIUS inc. All rights reserved.
@@ -37,6 +37,115 @@ export declare function softSheet(): typeof sheet;
 export declare function softOlap(): typeof olap;
 export declare function softTransposed(): typeof transposed;
 export declare function softTransposedMultiRow(): typeof transposedMultiRow;
+/**
+ * Represents arguments of the IFlexGridDrawSettings.formatItem callback.
+ */
+export declare class PdfFormatItemEventArgs extends /*wijmo.grid.CellRangeEventArgs*/ CancelEventArgs {
+    private _p;
+    private _rng;
+    private _data;
+    private _tagContent;
+    private _canvas;
+    private _cell;
+    private _clientRect;
+    private _contentRect;
+    private _textRect;
+    private _style;
+    private _getFormattedCell;
+    private _getTextRect;
+    /**
+     * Initializes a new instance of the {@link PdfFormatItemEventArgs} class.
+     *
+     * @param p {@link GridPanel} that contains the range.
+     * @param rng Range of cells affected by the event.
+     * @param cell Element that represents the grid cell to be rendered.
+     * @param canvas Canvas to perform the custom painting on.
+     * @param clientRect    Object that represents the client rectangle of the grid cell to be rendered in canvas coordinates.
+     * @param contentRect Object that represents the content rectangle of the grid cell to be rendered in canvas coordinates.
+     * @param style Object that represents the style of the grid cell to be rendered.
+     * @param getFormattedCell Callback function that should return the grid cell when the getFormattedCell method is called.
+     * @param getTextRect Callback function that should return the text rectangle of the grid cell to be rendered in canvas coordinates.
+     */
+    constructor(p: any, rng: any, cell: HTMLElement, canvas: PdfPageArea, clientRect: Rect, contentRect: Rect, style: ICellStyle, getFormattedCell: () => HTMLElement, getTextRect: () => Rect);
+    /**
+     * Gets the {@link GridPanel} affected by this event.
+     */
+    readonly panel: GridPanel;
+    /**
+     * Gets the {@link CellRange} affected by this event.
+     */
+    readonly range: CellRange;
+    /**
+     * Gets the row affected by this event.
+     */
+    readonly row: number;
+    /**
+     * Gets the column affected by this event.
+     */
+    readonly col: number;
+    /**
+     * Gets or sets the data associated with the event.
+     */
+    data: any;
+    /**
+     * Gets or sets a value that indicates that default cell borders drawing should be canceled.
+     */
+    cancelBorders: boolean;
+    /**
+     * Gets the canvas to perform the custom painting on.
+     */
+    readonly canvas: PdfPageArea;
+    /**
+     * Gets a reference to the element that represents the grid cell being rendered.
+     * If IFlexGridDrawSettings.customCellContent is set to true then contains
+     * reference to the element that represents the formatted grid cell; otherwise, a null value.
+     */
+    readonly cell: HTMLElement;
+    /**
+     * Gets the client rectangle of the cell being rendered in canvas coordinates.
+     */
+    readonly clientRect: Rect;
+    /**
+     * Gets the content rectangle of the cell being rendered in canvas coordinates.
+     */
+    readonly contentRect: Rect;
+    /**
+     * Draws the background of the cell with the specified brush or color, or, if it is not specified, with the value of the {@link style.backgroundColor} property.
+     * @param brush The brush or color to use.
+     */
+    drawBackground(brush?: PdfBrush | Color | string): void;
+    /**
+     * Returns a reference to the element that represents the grid cell being rendered.
+     * This method is useful when export of custom formatting is disabled, but you need
+     * to export custom content for certain cells.
+     */
+    getFormattedCell(): HTMLElement;
+    /**
+     * Gets or sets a reference to a marked structure content of the cell.
+     *
+     * If user produces Tagged PDF and draws the cell content manually, then he can mark the cell content and return a reference to the structure content via this property.
+     * The returned item will be incorporated into the document's structure tree.
+     *
+     * For example:
+     * <pre>
+     * args.tagContent = args.canvas.beginTagContent(wijmo.pdf.PdfTagType.P);
+     * args.canvas.drawText('Some text', x, y);
+     * args.canvas.endTagContent();
+     * </pre>
+     */
+    tagContent: IPdfTagContent | IPdfTag;
+    /**
+     * Gets an object that represents the style of the cell being rendered.
+     * If IFlexGridDrawSettings.customCellContent is set to true then the style is inferred
+     * from the cell style; othwerwise it contains a combination of the IFlexGridDrawSettings.styles export
+     * setting, according to the row type of exported cell.
+     */
+    readonly style: ICellStyle;
+    /**
+     * Gets the value that represents the top position of the text of the cell being rendered in canvas coordinates.
+     */
+    readonly textTop: number;
+}
 /**
  * Specifies how the grid content should be scaled to fit the page.
  */
@@ -244,6 +353,9 @@ export interface IFlexGridDrawSettings {
      */
     quickCellStyles?: boolean;
     _progressMax?: number;
+    _mergedCellTextState?: {
+        [key: string]: number;
+    };
 }
 /**
  * Represents the settings used by the {@link FlexGridPdfConverter.export} method.
@@ -355,115 +467,6 @@ export declare enum _CellType {
 export declare function _merge(dst: any, src: any, overwrite?: boolean): any;
 export declare function _combineColumns(regCol: _IColumn, bndCol: _IColumn): _IColumn;
 export declare function _cloneStyle(val: CSSStyleDeclaration): any;
-/**
- * Represents arguments of the IFlexGridDrawSettings.formatItem callback.
- */
-export declare class PdfFormatItemEventArgs extends /*wijmo.grid.CellRangeEventArgs*/ CancelEventArgs {
-    private _p;
-    private _rng;
-    private _data;
-    private _tagContent;
-    private _canvas;
-    private _cell;
-    private _clientRect;
-    private _contentRect;
-    private _textRect;
-    private _style;
-    private _getFormattedCell;
-    private _getTextRect;
-    /**
-     * Initializes a new instance of the {@link PdfFormatItemEventArgs} class.
-     *
-     * @param p {@link GridPanel} that contains the range.
-     * @param rng Range of cells affected by the event.
-     * @param cell Element that represents the grid cell to be rendered.
-     * @param canvas Canvas to perform the custom painting on.
-     * @param clientRect    Object that represents the client rectangle of the grid cell to be rendered in canvas coordinates.
-     * @param contentRect Object that represents the content rectangle of the grid cell to be rendered in canvas coordinates.
-     * @param style Object that represents the style of the grid cell to be rendered.
-     * @param getFormattedCell Callback function that should return the grid cell when the getFormattedCell method is called.
-     * @param getTextRect Callback function that should return the text rectangle of the grid cell to be rendered in canvas coordinates.
-     */
-    constructor(p: any, rng: any, cell: HTMLElement, canvas: PdfPageArea, clientRect: Rect, contentRect: Rect, style: ICellStyle, getFormattedCell: () => HTMLElement, getTextRect: () => Rect);
-    /**
-     * Gets the {@link GridPanel} affected by this event.
-     */
-    readonly panel: GridPanel;
-    /**
-     * Gets the {@link CellRange} affected by this event.
-     */
-    readonly range: CellRange;
-    /**
-     * Gets the row affected by this event.
-     */
-    readonly row: number;
-    /**
-     * Gets the column affected by this event.
-     */
-    readonly col: number;
-    /**
-     * Gets or sets the data associated with the event.
-     */
-    data: any;
-    /**
-     * Gets or sets a value that indicates that default cell borders drawing should be canceled.
-     */
-    cancelBorders: boolean;
-    /**
-     * Gets the canvas to perform the custom painting on.
-     */
-    readonly canvas: PdfPageArea;
-    /**
-     * Gets a reference to the element that represents the grid cell being rendered.
-     * If IFlexGridDrawSettings.customCellContent is set to true then contains
-     * reference to the element that represents the formatted grid cell; otherwise, a null value.
-     */
-    readonly cell: HTMLElement;
-    /**
-     * Gets the client rectangle of the cell being rendered in canvas coordinates.
-     */
-    readonly clientRect: Rect;
-    /**
-     * Gets the content rectangle of the cell being rendered in canvas coordinates.
-     */
-    readonly contentRect: Rect;
-    /**
-     * Draws the background of the cell with the specified brush or color, or, if it is not specified, with the value of the {@link style.backgroundColor} property.
-     * @param brush The brush or color to use.
-     */
-    drawBackground(brush?: PdfBrush | Color | string): void;
-    /**
-     * Returns a reference to the element that represents the grid cell being rendered.
-     * This method is useful when export of custom formatting is disabled, but you need
-     * to export custom content for certain cells.
-     */
-    getFormattedCell(): HTMLElement;
-    /**
-     * Gets or sets a reference to a marked structure content of the cell.
-     *
-     * If user produces Tagged PDF and draws the cell content manually, then he can mark the cell content and return a reference to the structure content via this property.
-     * The returned item will be incorporated into the document's structure tree.
-     *
-     * For example:
-     * <pre>
-     * args.tagContent = args.canvas.beginTagContent(wijmo.pdf.PdfTagType.P);
-     * args.canvas.drawText('Some text', x, y);
-     * args.canvas.endTagContent();
-     * </pre>
-     */
-    tagContent: IPdfTagContent | IPdfTag;
-    /**
-     * Gets an object that represents the style of the cell being rendered.
-     * If IFlexGridDrawSettings.customCellContent is set to true then the style is inferred
-     * from the cell style; othwerwise it contains a combination of the IFlexGridDrawSettings.styles export
-     * setting, according to the row type of exported cell.
-     */
-    readonly style: ICellStyle;
-    /**
-     * Gets the value that represents the top position of the text of the cell being rendered in canvas coordinates.
-     */
-    readonly textTop: number;
-}
 /**
  * Provides a functionality to export the {@link FlexGrid} to PDF.
  */
@@ -591,6 +594,7 @@ export declare class _CellRenderer {
     private _area;
     private _borderWidth;
     private readonly InvisiblePen;
+    _lastRenderCharCount: number;
     constructor(panelRenderer: PanelSectionRenderer, area: pdf.PdfPageArea, borderWidth: number);
     renderCell(value: string, row: _IRow, column: _IColumn, rng: _CellRangeExt, r: Rect): pdf.IPdfTagContent | pdf.IPdfTag;
     private _renderCell;
@@ -653,140 +657,140 @@ declare class RowRange {
 }
 export declare function _removeFakeCell(): void;
 /**
-* Provides a functionality to export the {@link FlexGrid} to PDF.
-*
-* The example below shows how you can use a {@link FlexGridPdfConverter} to
-* export a {@link FlexGrid} to PDF:
-*
-* {@sample Grid/ImportExportPrint/PDF/ExportToFile/purejs Example}
-*/
+ * Provides a functionality to export the {@link FlexGrid} to PDF.
+ *
+ * The example below shows how you can use a {@link FlexGridPdfConverter} to
+ * export a {@link FlexGrid} to PDF:
+ *
+ * {@sample Grid/ImportExportPrint/PDF/ExportToFile/purejs Example}
+ */
 export declare class FlexGridPdfConverter {
     static _DefaultExportSettings: IFlexGridExportSettings;
     /**
-    * Draws the {@link FlexGrid} to an existing {@link PdfDocument} at the
-    * (0, @wijmo.pdf.PdfDocument.y) coordinates.
-    *
-    * If both, **width** and **height** are determined, then grid will be scaled to fit the
-    * specified rectangle without any page breaks.
-    * If only **width** is specifed, then grid will be scaled to fit the width, breaking
-    * into pages vertically as needed.
-    * Otherwise grid will be rendered in actual size, breaking into pages as needed.
-    *
-    * <pre>
-    * var doc = new wijmo.pdf.PdfDocument({
-    *    ended: function (sender, args) {
-    *       wijmo.pdf.saveBlob(args.blob, 'FlexGrid.pdf');
-    *    }
-    * });
-    *
-    * wijmo.grid.pdf.FlexGridPdfConverter.draw(grid, doc, null, null, {
-    *    maxPages: 10,
-    *    styles: {
-    *       cellStyle: {
-    *          backgroundColor: '#ffffff',
-    *          borderColor: '#c6c6c6'
-    *       },
-    *       headerCellStyle: {
-    *          backgroundColor: '#eaeaea'
-    *       }
-    *    }
-    * });
-    * </pre>
-    *
-    * @param flex The {@link FlexGrid} instance to export.
-    * @param doc The {@link PdfDocument} instance to draw in.
-    * @param width The width of the drawing area in points.
-    * @param height The height of the drawing area in points.
-    * @param settings The draw settings.
-    */
+     * Draws the {@link FlexGrid} to an existing {@link PdfDocument} at the
+     * (0, @wijmo.pdf.PdfDocument.y) coordinates.
+     *
+     * If both, **width** and **height** are determined, then grid will be scaled to fit the
+     * specified rectangle without any page breaks.
+     * If only **width** is specifed, then grid will be scaled to fit the width, breaking
+     * into pages vertically as needed.
+     * Otherwise grid will be rendered in actual size, breaking into pages as needed.
+     *
+     * <pre>
+     * var doc = new wijmo.pdf.PdfDocument({
+     *    ended: function (sender, args) {
+     *       wijmo.pdf.saveBlob(args.blob, 'FlexGrid.pdf');
+     *    }
+     * });
+     *
+     * wijmo.grid.pdf.FlexGridPdfConverter.draw(grid, doc, null, null, {
+     *    maxPages: 10,
+     *    styles: {
+     *       cellStyle: {
+     *          backgroundColor: '#ffffff',
+     *          borderColor: '#c6c6c6'
+     *       },
+     *       headerCellStyle: {
+     *          backgroundColor: '#eaeaea'
+     *       }
+     *    }
+     * });
+     * </pre>
+     *
+     * @param flex The {@link FlexGrid} instance to export.
+     * @param doc The {@link PdfDocument} instance to draw in.
+     * @param width The width of the drawing area in points.
+     * @param height The height of the drawing area in points.
+     * @param settings The draw settings.
+     */
     static draw(flex: any, doc: pdf.PdfDocument, width?: number, height?: number, settings?: IFlexGridDrawSettings): void;
     /**
-    * Draws the {@link FlexGrid} to an existing {@link PdfDocument} instance at the
-    * specified coordinates.
-    *
-    * If both, **width** and **height** are determined, then grid will be scaled to fit
-    * the specified rectangle without any page breaks.
-    * If only **width** is specified, then grid will be scaled to fit the width without
-    * any page breaks.
-    * Othwerwise grid will be rendered in actual size without any page breaks.
-    *
-    * <pre>
-    * var doc = new wijmo.pdf.PdfDocument({
-    *    ended: function (sender, args) {
-    *       wijmo.pdf.saveBlob(args.blob, 'FlexGrid.pdf');
-    *    }
-    * });
-    *
-    * wijmo.grid.pdf.FlexGridPdfConverter.drawToPosition(grid, doc, new wijmo.Point(0, 0), null, null, {
-    *    maxPages: 10,
-    *    styles: {
-    *       cellStyle: {
-    *          backgroundColor: '#ffffff',
-    *          borderColor: '#c6c6c6'
-    *       },
-    *       headerCellStyle: {
-    *          backgroundColor: '#eaeaea'
-    *       }
-    *    }
-    * });
-    * </pre>
-    *
-    * @param flex The {@link FlexGrid} instance to export.
-    * @param doc The {@link PdfDocument} instance to draw in.
-    * @param point The position to draw at, in points.
-    * @param width The width of the drawing area in points.
-    * @param height The height of the drawing area in points.
-    * @param settings The draw settings.
-    */
+     * Draws the {@link FlexGrid} to an existing {@link PdfDocument} instance at the
+     * specified coordinates.
+     *
+     * If both, **width** and **height** are determined, then grid will be scaled to fit
+     * the specified rectangle without any page breaks.
+     * If only **width** is specified, then grid will be scaled to fit the width without
+     * any page breaks.
+     * Othwerwise grid will be rendered in actual size without any page breaks.
+     *
+     * <pre>
+     * var doc = new wijmo.pdf.PdfDocument({
+     *    ended: function (sender, args) {
+     *       wijmo.pdf.saveBlob(args.blob, 'FlexGrid.pdf');
+     *    }
+     * });
+     *
+     * wijmo.grid.pdf.FlexGridPdfConverter.drawToPosition(grid, doc, new wijmo.Point(0, 0), null, null, {
+     *    maxPages: 10,
+     *    styles: {
+     *       cellStyle: {
+     *          backgroundColor: '#ffffff',
+     *          borderColor: '#c6c6c6'
+     *       },
+     *       headerCellStyle: {
+     *          backgroundColor: '#eaeaea'
+     *       }
+     *    }
+     * });
+     * </pre>
+     *
+     * @param flex The {@link FlexGrid} instance to export.
+     * @param doc The {@link PdfDocument} instance to draw in.
+     * @param point The position to draw at, in points.
+     * @param width The width of the drawing area in points.
+     * @param height The height of the drawing area in points.
+     * @param settings The draw settings.
+     */
     static drawToPosition(flex: any, doc: pdf.PdfDocument, point: Point, width?: number, height?: number, settings?: IFlexGridDrawSettings): void;
     /**
-    * Exports the {@link FlexGrid} to PDF.
-    *
-    * <pre>
-    * wijmo.grid.pdf.FlexGridPdfConverter.export(grid, 'FlexGrid.pdf', {
-    *    scaleMode: wijmo.grid.pdf.ScaleMode.PageWidth,
-    *    maxPages: 10,
-    *    styles: {
-    *       cellStyle: {
-    *          backgroundColor: '#ffffff',
-    *          borderColor: '#c6c6c6'
-    *       },
-    *       headerCellStyle: {
-    *          backgroundColor: '#eaeaea'
-    *       }
-    *    },
-    *    documentOptions: {
-    *       info: {
-    *          title: 'Sample'
-    *       }
-    *    }
-    * });
-    * </pre>
-    *
-    * @param flex The {@link FlexGrid} instance to export.
-    * @param fileName Name of the file to export.
-    * @param settings The export settings.
-    */
+     * Exports the {@link FlexGrid} to PDF.
+     *
+     * <pre>
+     * wijmo.grid.pdf.FlexGridPdfConverter.export(grid, 'FlexGrid.pdf', {
+     *    scaleMode: wijmo.grid.pdf.ScaleMode.PageWidth,
+     *    maxPages: 10,
+     *    styles: {
+     *       cellStyle: {
+     *          backgroundColor: '#ffffff',
+     *          borderColor: '#c6c6c6'
+     *       },
+     *       headerCellStyle: {
+     *          backgroundColor: '#eaeaea'
+     *       }
+     *    },
+     *    documentOptions: {
+     *       info: {
+     *          title: 'Sample'
+     *       }
+     *    }
+     * });
+     * </pre>
+     *
+     * @param flex The {@link FlexGrid} instance to export.
+     * @param fileName Name of the file to export.
+     * @param settings The export settings.
+     */
     static export(flex: grid.FlexGrid, fileName: string, settings?: IFlexGridExportSettings): void;
     static _getFlexGridAdapter(flex: grid.FlexGrid, settings: IFlexGridDrawSettings): _IFlexGridAdapter;
     static _applyDefaultExportSettings(settings: any): IFlexGridExportSettings;
 }
 /**
-* Represents a single item of the {@link IClientData} dictionary.
-*/
+ * Represents a single item of the {@link IClientData} dictionary.
+ */
 export interface IClientDataItem {
     /**
-    * Gets or sets the content for the data item.
-    */
+     * Gets or sets the content for the data item.
+     */
     content: any;
     /**
-    * Gets or sets the settings for the data item.
-    */
+     * Gets or sets the settings for the data item.
+     */
     settings: any;
 }
 /**
-* Represents a dictionary of {name: value} pairs which contains client data.
-*/
+ * Represents a dictionary of {name: value} pairs which contains client data.
+ */
 export interface IClientData {
     [name: string]: IClientDataItem;
 }
@@ -797,18 +801,18 @@ export declare class PdfWebWorkerExportDoneEventArgs extends EventArgs {
     private _blob;
     private _buf;
     /**
-    * Initializes a new instance of the {@link PdfWebWorkerExportDoneEventArgs} class.
-    *
-    * @param buffer An ArrayBuffer.
-    */
+     * Initializes a new instance of the {@link PdfWebWorkerExportDoneEventArgs} class.
+     *
+     * @param buffer An ArrayBuffer.
+     */
     constructor(buffer: ArrayBuffer);
     /**
-    * Gets a Blob object that contains the document data.
-    */
+     * Gets a Blob object that contains the document data.
+     */
     readonly blob: Blob;
     /**
-    * Gets an ArrayBuffer that contains the document data.
-    */
+     * Gets an ArrayBuffer that contains the document data.
+     */
     readonly buffer: ArrayBuffer;
 }
 /**
@@ -868,11 +872,11 @@ export declare class PdfWebWorkerClient {
      */
     static addString(worker: Worker, value: string, name: string): void;
     /**
-    * Serializes the {@link FlexGrid} to ArrayBuffer. The serialized data can be send to a Web Worker using the postMessage method.
-    *
-    * @param grid The {@link FlexGrid} instance to serialize.
-    * @param settings The export settings used to serialize the grid.
-    */
+     * Serializes the {@link FlexGrid} to ArrayBuffer. The serialized data can be send to a Web Worker using the postMessage method.
+     *
+     * @param grid The {@link FlexGrid} instance to serialize.
+     * @param settings The export settings used to serialize the grid.
+     */
     static serializeGrid(grid: grid.FlexGrid, settings?: IFlexGridExportSettings): ArrayBuffer;
     private static _addClientData;
     private static _clearClientData;
@@ -907,11 +911,11 @@ export declare class PdfWebWorker {
      */
     static sendExportProgress(value: number): void;
     /**
-    * Deserializes the {@link FlexGrid} from ArrayBuffer to its internal representation that can be used in a Web Worker and passed to the {@link FlexGridPdfConverter.draw} and {@link FlexGridPdfConverter.drawToPosition} methods.
-    *
-    * @param data The data to deserialize.
-    * @param settings The draw settings used to deserialize the grid.
-    */
+     * Deserializes the {@link FlexGrid} from ArrayBuffer to its internal representation that can be used in a Web Worker and passed to the {@link FlexGridPdfConverter.draw} and {@link FlexGridPdfConverter.drawToPosition} methods.
+     *
+     * @param data The data to deserialize.
+     * @param settings The draw settings used to deserialize the grid.
+     */
     static deserializeGrid(data: ArrayBuffer, settings?: IFlexGridDrawSettings): any;
     private static _deserializeGridFromString;
     private static _disableUnsupportedFeatures;