[]
DEMO DOCS API
DOWNLOAD
(Showing Draft Content)

XlsxExport

Namespace: XlsxExport

Table of contents

Type aliases

Functions

Type aliases

CheckCancelCallback

Ƭ CheckCancelCallback: () => boolean

Type declaration

▸ (): boolean

The type of callback that gets called before sheet rendering, the render process will be canceled if the function returns true.

Returns

boolean

Defined in

node_modules/@grapecity/ar-js-xlsx/dist/ar-js-xlsx.d.ts:44

OnProgressCallback

Ƭ OnProgressCallback: (pageNumber: number) => void

Type declaration

▸ (pageNumber): void

The type of callback that gets called after each sheet is rendered.

Parameters
Name Type
pageNumber number
Returns

void

Defined in

node_modules/@grapecity/ar-js-xlsx/dist/ar-js-xlsx.d.ts:42

PageSettings

Ƭ PageSettings: Object

Page settings.

Type declaration

Name Type Description
orientation? "portrait" | "landscape" Page orientation.
size? PageSize Page size.

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"

Page size

Defined in

node_modules/@grapecity/ar-js-xlsx/dist/ar-js-xlsx.d.ts:8

XlsxExportResult

Ƭ XlsxExportResult: Object

Export result

Type declaration

Name Type Description
data Blob Result content.
download (filename?: string) => void -

Defined in

node_modules/@grapecity/ar-js-xlsx/dist/ar-js-xlsx.d.ts:35

XlsxSettings

Ƭ XlsxSettings: Object

Xlsx export settings.

Type declaration

Name Type Description
info? XlsxSettingsInfo Document metadata.
pageSettings? PageSettings Page settings.
password? string Encrypts a document with a password.
sheetName? string The sheet name prefix, e.g. "Sheet_".

Defined in

node_modules/@grapecity/ar-js-xlsx/dist/ar-js-xlsx.d.ts:22

XlsxSettingsInfo

Ƭ XlsxSettingsInfo: Object

Xlsx info

Type declaration

Name Type Description
creator? string Creator

Defined in

node_modules/@grapecity/ar-js-xlsx/dist/ar-js-xlsx.d.ts:10

Functions

exportDocument

▸ exportDocument(source, settings?, onProgress?, checkCancel?): Promise<XlsxExportResult>

Exports a provided PageDocument to the XLSX format and returns it as Blob.

Parameters

Name Type Description
source PageDocument | VDomRenderer The document to export.
settings? XlsxSettings Export settings.
onProgress? OnProgressCallback The callback that gets called after each sheet is rendered.
checkCancel? CheckCancelCallback The callback that gets called before sheet rendering, the render process will be canceled if the function returns true.

Returns

Promise<XlsxExportResult>

Defined in

node_modules/@grapecity/ar-js-xlsx/dist/ar-js-xlsx.d.ts:53