XlsxExport
名前空間: XlsxExport
Table of contents
型の別名
- CheckCancelCallback
- OnProgressCallback
- PageSettings
- PageSize
- XlsxExportResult
- XlsxSettings
- XlsxSettingsInfo
関数
型の別名
CheckCancelCallback
Ƭ CheckCancelCallback: () => boolean
型宣言
▸ (): boolean
シートが描画される前に呼び出されるコールバック。関数は「true」 を返す場合、描画処理がキャンセルされます。
戻り値
boolean
Defined in
node_modules/@grapecity/ar-js-xlsx/dist/ar-js-xlsx.d.ts:44
OnProgressCallback
Ƭ OnProgressCallback: (pageNumber: number) => void
型宣言
▸ (pageNumber): void
各シートが描画された後に呼び出されるコールバックの種類。
パラメータ
| 名前 | 型 |
|---|---|
pageNumber |
number |
戻り値
void
Defined in
node_modules/@grapecity/ar-js-xlsx/dist/ar-js-xlsx.d.ts:42
PageSettings
Ƭ PageSettings: Object
ページの設定。
型宣言
| 名前 | 型 | 説明 |
|---|---|---|
orientation? |
"portrait" | "landscape" |
ページの向き。 |
size? |
PageSize |
ページのサイズ。 |
Defined in
node_modules/@grapecity/ar-js-xlsx/dist/ar-js-xlsx.d.ts:15
PageSize
Ƭ PageSize: "Letter" | "Legal" | "Executive" | "A4" | "A5" | "B5" | "Envelope_10" | "Envelope_DL" | "Envelope_C5" | "Envelope_B5" | "Envelope_Monarch" | "Double_Japan_Postcard_Rotated" | "K16_197x273_mm"
ページのサイズ。
Defined in
node_modules/@grapecity/ar-js-xlsx/dist/ar-js-xlsx.d.ts:8
XlsxExportResult
Ƭ XlsxExportResult: Object
エクスポート結果。
型宣言
| 名前 | 型 | 説明 |
|---|---|---|
data |
Blob |
エクスポート結果のコンテンツ。 |
download |
(filename?: string) => void |
- |
Defined in
node_modules/@grapecity/ar-js-xlsx/dist/ar-js-xlsx.d.ts:35
XlsxSettings
Ƭ XlsxSettings: Object
Xlsxのエクスポート設定。
型宣言
| 名前 | 型 | 説明 |
|---|---|---|
info? |
XlsxSettingsInfo |
ドキュメントメタデータ。 |
pageSettings? |
PageSettings |
ページの設定。 |
password? |
string |
パスワードで文書を暗号化します。 |
sheetName? |
string |
シート名の接頭辞（例：”Sheet_”）。 |
Defined in
node_modules/@grapecity/ar-js-xlsx/dist/ar-js-xlsx.d.ts:22
XlsxSettingsInfo
Ƭ XlsxSettingsInfo: Object
Xlsxの情報。
型宣言
| 名前 | 型 | 説明 |
|---|---|---|
creator? |
string |
Creator |
Defined in
node_modules/@grapecity/ar-js-xlsx/dist/ar-js-xlsx.d.ts:10
関数
exportDocument
▸ exportDocument(source, settings?, onProgress?, checkCancel?): Promise<XlsxExportResult>
指定されたPageDocumentをXLSX形式にエクスポートし、BLOBとして返します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
source |
PageDocument | VDomRenderer |
エクスポートする文書。 |
settings? |
XlsxSettings |
エクスポート設定。 |
onProgress? |
OnProgressCallback |
各シートが描画された後に呼び出されるコールバック。 |
checkCancel? |
CheckCancelCallback |
各シートが描画される前に呼び出されるコールバック。関数は「true」 を返す場合、描画処理がキャンセルされます。 |
戻り値
Promise<XlsxExportResult>
Defined in
node_modules/@grapecity/ar-js-xlsx/dist/ar-js-xlsx.d.ts:53