TabularDataExport
名前空間: TabularDataExport
Table of contents
型の別名
関数
型の別名
CheckCancelCallback
Ƭ CheckCancelCallback: () => boolean
型宣言
▸ (): boolean
各シートが描画される前に呼び出されるコールバック。関数は「true」 を返す場合、描画処理がキャンセルされます。
戻り値
boolean
CsvSettings
Ƭ CsvSettings: Object
Csvのエクスポート設定。
型宣言
| 名前 | 型 | 説明 |
|---|---|---|
colSeparator? |
string |
列区切り文字。 |
outputType? |
"zip" | "plain" |
各テーブルを個別のファイル（「zip」）としてエクスポートするか、単一のCSVに結合します。 |
quotationSymbol? |
string |
引用符。 |
rowSeparator? |
string |
行区切り文字。 |
tableSeparator? |
string |
テーブル区切り文字。 |
OnProgressCallback
Ƭ OnProgressCallback: (pageNumber: number) => void
型宣言
▸ (pageNumber): void
各シートが描画された後に呼び出されるコールバックの種類。
パラメータ
| 名前 | 型 |
|---|---|
pageNumber |
number |
戻り値
void
TabularDataExportResult
Ƭ TabularDataExportResult: Object
エクスポート結果。
型宣言
| 名前 | 型 | 説明 |
|---|---|---|
data |
Blob | string |
エクスポート結果のコンテンツ。 |
download |
(filename?: string) => void |
ブラウザをエクスポートの結果を含むファイルをダウンロードするためにトリガーします。 |
TabularDataSettings
Ƭ TabularDataSettings: Object
表形式のデータのエクスポート設定。
型宣言
| 名前 | 型 | 説明 |
|---|---|---|
csvSettings? |
CsvSettings |
CSVのエクスポート設定。 |
format? |
"csv" |
エクスポート形式。 |
関数
exportDocument
▸ exportDocument(source, settings?, onProgress?, checkCancel?): Promise<TabularDataExportResult>
提供されたPageDocumentを表形式のデータ形式にエクスポートし、Blobまたは文字列として返します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
source |
PageDocument | VDomRenderer |
エクスポートするドキュメント。 |
settings? |
TabularDataSettings |
エクスポート設定。 |
onProgress? |
OnProgressCallback |
各シートが描画された後に呼び出されるコールバック。 |
checkCancel? |
CheckCancelCallback |
各シートが描画される前に呼び出されるコールバック。関数は「true」 を返す場合、描画処理がキャンセルされます。 |
戻り値
Promise<TabularDataExportResult>