Represents client-side methods for exporting FlexGrid to PDF/generating PDF, for use with Web Worker.
addGrid(worker: Worker, grid: FlexGrid, name: string, settings: IFlexGridDrawSettings): void
Adds named FlexGrid with settings, which will be used in a Web Worker to generate a PDF document. This method should be used in conjunction with the export method.
The Web Worker instance to send the data to.
The grid
The name associated with the grid.
The draw settings.
addImage(worker: Worker, image: string, name: string, settings: IPdfImageDrawSettings): void
Adds named image with settings, which will be used in a Web Worker to generate a PDF document. This method should be used in conjunction with the export method.
The Web Worker instance to send the data to.
A string containing the URL to get the image from or the data URI containing a base64 encoded image.
The name associated with the image.
The image drawing settings.
addString(worker: Worker, value: string, name: string): void
Adds named string which will be used in a Web Worker code to generate a PDF document. This method should be used in conjunction with the export method.
The Web Worker instance to send the data to.
The value.
The name associated with the string.
export(worker: Worker, settings: any, done: Function, progress?: Function): void
Exports PDF in a background thread.
The Web Worker instance to run the exporting code in.
An object containing PdfDocument's initialization settings.
The callback function to call when drawing is done. The function takes a single parameter, an instance of the PdfWebWorkerExportDoneEventArgs class.
An optional function that gives feedback about the progress of the export. The function takes a single parameter, a number changing from 0.0 to 1.0, where the value of 0.0 indicates that the operation has just begun and the value of 1.0 indicates that the operation has completed.
exportGrid(worker: Worker, grid: FlexGrid, fileName: string, settings: IFlexGridExportSettings, done?: Function, progress?: Function): void
Exports the FlexGrid to PDF in a background thread.
The Web Worker instance to run the exporting code in.
The FlexGrid instance to export.
The name of the file to export.
The export settings.
An optional callback function to call when exporting is done. The function takes a single parameter, an instance of the PdfWebWorkerExportDoneEventArgs class.
An optional function that gives feedback about the progress of the export. The function takes a single parameter, a number changing from 0.0 to 1.0, where the value of 0.0 indicates that the operation has just begun and the value of 1.0 indicates that the operation has completed.
serializeGrid(grid: FlexGrid, settings?: IFlexGridExportSettings): ArrayBuffer
Serializes the FlexGrid to ArrayBuffer. The serialized data can be send to a Web Worker using the postMessage method.
The FlexGrid instance to serialize.
The export settings used to serialize the grid.