ASP.NET Core MVC Controls | ComponentOne
In This Topic
    PdfWebWorkerClient Class
    In This Topic
    File
    wijmo.grid.pdf.js
    Module
    wijmo.grid.pdf

    Represents client-side methods for exporting FlexGrid to PDF/generating PDF, for use with Web Worker.

    Methods

    Methods

     

    Static addGrid
    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.

    Parameters
    Optional

    The draw settings.

    Returns
    void

     

    Static addImage
    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.

    Parameters
    Returns
    void

    Static addString

    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.

    Parameters
    • worker: Worker

      The Web Worker instance to send the data to.

    • value: string

      The value.

    • name: string

      The name associated with the string.

    Returns
    void

    Static export

    export(worker: Worker, settings: any, done?: (args: PdfWebWorkerExportDoneEventArgs), progress?: (value: number)): void
    

    Exports PDF in a background thread.

    Parameters
    • worker: Worker

      The Web Worker instance to run the exporting code in.

    • settings: any

      An object containing PdfDocument's initialization settings.

    • done: (args: PdfWebWorkerExportDoneEventArgs) Optional

      The callback function to call when drawing is done. The function takes a single parameter, an instance of the PdfWebWorkerExportDoneEventArgs class.

    • progress: (value: number) Optional

      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.

    Returns
    void

    Static exportGrid

    exportGrid(worker: Worker, grid: FlexGrid, fileName: string, settings?: IFlexGridExportSettings, done?: (args: PdfWebWorkerExportDoneEventArgs), progress?: (value: number)): void
    

    Exports the FlexGrid to PDF in a background thread.

    Parameters
    • worker: Worker

      The Web Worker instance to run the exporting code in.

    • grid: FlexGrid

      The FlexGrid instance to export.

    • fileName: string

      The name of the file to export.

    • settings: IFlexGridExportSettings Optional

      The export settings.

    • done: (args: PdfWebWorkerExportDoneEventArgs) Optional

      An optional callback function to call when exporting is done. The function takes a single parameter, an instance of the PdfWebWorkerExportDoneEventArgs class. To prevent the creation of a file the function should return False.

    • progress: (value: number) Optional

      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.

    Returns
    void

    Static serializeGrid

    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.

    Parameters
    Returns
    ArrayBuffer