ASP.NET MVC コントロールヘルプ
PdfWebWorkerClient クラス
ファイル
wijmo.grid.pdf.js
モジュール
wijmo.grid.pdf

Web Workersで利用できる、FlexGridをPDFにエクスポートするか、またはPDFを生成するクライアント側のメソッドを表します。

メソッド

メソッド

Static addGrid

addGrid(worker: Worker, grid: FlexGrid, name: string, settings?: IFlexGridDrawSettings): void

PDFドキュメントを生成するためにWeb Workersで使用できる名前付きのFlexGridを追加します。 このメソッドは {export メソッドと組み合わせて使用する必要があります。

パラメーター
  • worker: Worker

    The Web Worker instance to send the data to.

  • grid: FlexGrid

    The grid

  • name: string

    The name associated with the grid.

  • settings: IFlexGridDrawSettings Optional

    The draw settings.

戻り値
void

Static addImage

addImage(worker: Worker, image: string, name: string, settings?: IPdfImageDrawSettings): void

PDFドキュメントを生成するためにWeb Workersで使用できる名前付き画像を追加します。 このメソッドは export メソッドと組み合わせて使用する必要があります。

パラメーター
  • worker: Worker

    The Web Worker instance to send the data to.

  • image: string

    A string containing the URL to get the image from or the data URI containing a base64 encoded image.

  • name: string

    The name associated with the image.

  • settings: wijmo.pdf.IPdfImageDrawSettings Optional

    The image drawing settings.

戻り値
void

Static addString

addString(worker: Worker, value: string, name: string): void

PDFドキュメントを生成するためにWeb Workersのコードで使用できる名前付き文字列を追加します。 このメソッドは export メソッドと組み合わせて使用する必要があります。

パラメーター
  • worker: Worker

    The Web Worker instance to send the data to.

  • value: string

    The value.

  • name: string

    The name associated with the string.

戻り値
void

Static export

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

バックグラウンドスレッドでPDFをエクスポートします。

パラメーター
  • 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.

戻り値
void

Static exportGrid

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

FlexGrid をバックグラウンドスレッドでPDFにエクスポートします。

パラメーター
  • 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.

戻り値
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.

パラメーター
戻り値
ArrayBuffer